ModifiedFormatOutput

java.lang.Object
- java.lang.Enum<ModifiedFormatOutput>
- - com.deltaxml.cores9api.config.ModifiedFormatOutput

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModifiedFormatOutput>
```
public enum ModifiedFormatOutput
extends java.lang.Enum<ModifiedFormatOutput>
```
Specifies how modified 'formatting' elements should be output.

The DocumentComparator and deltaV2.1 have the ability to represent overlapping hierarchies from the A and B input documents by flattening and subsequently fragmenting the elements where necessary. In order to produce a meaningful result when deltaV2.1 is not the output format, these overlapping hierarchies must be reconciled in some way. This enumeration represents the different options for processing the elements that were flattened in the inputs.

Since:

7.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`A` Output only the formatting elements from the A input.
`AB` Output the A and B formatting elements.
`AUTOMATIC` Choose the most relevant behaviour based on other configuration settings.
`B` Output only the formatting elements from the B input.
`BA` Output the A and B formatting elements.
`CHANGE` Represent all formatting element changes using the deltaV2.1 format.
`CONTENT_GROUP` Output the formatting element change using content group.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ModifiedFormatOutput`	`getModifiedFormatOutput(java.lang.String val)` Returns the `ModifiedFormatOutput` instance representing the supplied String value.
`java.lang.String`	`toString()`
`static ModifiedFormatOutput`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ModifiedFormatOutput[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AUTOMATIC
```
public static final ModifiedFormatOutput AUTOMATIC
```
    Choose the most relevant behaviour based on other configuration settings.
    
    For example, if the ResultFormat is one of the tracked change formats, ModifiedFormatOutput.BA will be selected.
  - A
```
public static final ModifiedFormatOutput A
```
    Output only the formatting elements from the A input.
  - B
```
public static final ModifiedFormatOutput B
```
    Output only the formatting elements from the B input.
  - AB
```
public static final ModifiedFormatOutput AB
```
    Output the A and B formatting elements. Where A and B formatting elements overlap or are nested, use formatting elements from the A input.
  - BA
```
public static final ModifiedFormatOutput BA
```
    Output the A and B formatting elements. Where A and B formatting elements overlap or are nested, use formatting elements from the B input.
  - CHANGE
```
public static final ModifiedFormatOutput CHANGE
```
    Represent all formatting element changes using the deltaV2.1 format.
  - CONTENT_GROUP
```
public static final ModifiedFormatOutput CONTENT_GROUP
```
    Output the formatting element change using content group.
- Method Detail
  - values
```
public static ModifiedFormatOutput[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ModifiedFormatOutput c : ModifiedFormatOutput.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ModifiedFormatOutput valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<ModifiedFormatOutput>
  - getModifiedFormatOutput
```
public static ModifiedFormatOutput getModifiedFormatOutput(java.lang.String val)
```
    Returns the ModifiedFormatOutput instance representing the supplied String value.
    
    This method should not be used under normal circumstances, enum instance values should be used instead.
    
    Parameters:
    
    val - a Sting representation of a ModifiedFormatOutput value or null for the default value
    
    Returns:
    
    the ModifiedFormatOutput instance corresponding to the parameter, or null if the value is invalid

Enum ModifiedFormatOutput

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTOMATIC

A

B

AB

BA

CHANGE

CONTENT_GROUP

Method Detail

values

valueOf

toString

getModifiedFormatOutput