Package com.deltaxml.core.config

Enum Class ResultFormat

java.lang.Object
java.lang.Enum<ResultFormat>
com.deltaxml.core.config.ResultFormat
All Implemented Interfaces:
Serializable, Comparable<ResultFormat>, Constable
public enum ResultFormat extends Enum<ResultFormat>

Specifies the format of results output from the DocumentComparator.

Since:
7.0

  • Enum Constant Details

    • DELTA

      public static final ResultFormat DELTA

      Reports changes using the DeltaXML delta file result.

    • OXYGEN_TC

      public static final ResultFormat OXYGEN_TC

      Reports changes using oXygen Author track changes processing instructions.

    • ARBORTEXT_TC

      public static final ResultFormat ARBORTEXT_TC

      Reports changes using the Arbortext editor track changes format.

    • XMETAL_TC

      public static final ResultFormat XMETAL_TC

      Reports changes using XMetaL track changes processing instructions.

    • FRAMEMAKER_TC

      public static final ResultFormat FRAMEMAKER_TC

      Reports changes using Framemaker track changes processing instructions.

  • Method Details

    • values

      public static ResultFormat[] 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 ResultFormat 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()
      The camel case string form of each of the enumerated type constants. Here, the string for an enumeration constant of the form 'FIRST_SECOND_THIRD' is 'firstSecondThird'.
      Overrides:
      toString in class Enum<ResultFormat>
      Returns:
      The camel case string form of each of the enumerated type constants.

    • getResultFormat

      public static ResultFormat getResultFormat(String val)

      Returns a ResultFormat object based on the supplied String value.

      This method should not be used under normal circumstances, enum instance values should be used instead.

      Parameters:
      val - a String representation of a ResultFormat value or null to get the default value
      Returns:
      the ResultFormat instance corresponding to the supplied value, or null if the value is invalid