Package com.deltaxml.core.config

Enum Class ModifiedFormatOutput

java.lang.Object
java.lang.Enum<ModifiedFormatOutput>
com.deltaxml.core.config.ModifiedFormatOutput
All Implemented Interfaces:
Serializable, Comparable<ModifiedFormatOutput>, Constable
public enum ModifiedFormatOutput extends 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 Details

    • 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, 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 Details

    • values

      public static ModifiedFormatOutput[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ModifiedFormatOutput valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ModifiedFormatOutput>

    • getModifiedFormatOutput

      public static ModifiedFormatOutput getModifiedFormatOutput(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