Package com.deltaxml.dita.config

Enum Class PreservationMode

java.lang.Object
java.lang.Enum<PreservationMode>
com.deltaxml.dita.config.PreservationMode
All Implemented Interfaces:
com.deltaxml.dita.DitaCompareDisplayable, Serializable, Comparable<PreservationMode>, Constable
public enum PreservationMode extends Enum<PreservationMode> implements com.deltaxml.dita.DitaCompareDisplayable
An enum representing the different document preservation modes.

  • Enum Constant Details

    • AUTOMATIC

      public static final PreservationMode AUTOMATIC
      Chooses the most appropriate setting based on the output format. If tracked changes are being produced, this will be 'roundTrip', otherwise 'docAndAttrib' will be used.

    • DOCUMENT

      public static final PreservationMode DOCUMENT
      Preserve document typing information.

    • DOC_AND_ATTRIB

      public static final PreservationMode DOC_AND_ATTRIB
      Preserve document typing and original attribute information.

    • ROUND_TRIP

      public static final PreservationMode ROUND_TRIP
      Preserve document type, entity usage, and attribute usage data.

    • ENTITY_REF

      public static final PreservationMode ENTITY_REF
      Enhance round-trip processing by analysing entity contents.

    • NESTED_ENTITY_REF

      public static final PreservationMode NESTED_ENTITY_REF
      Enhance round-trip processing by analysing both entity and nested entity contents.

  • Method Details

    • values

      public static PreservationMode[] 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 PreservationMode 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

    • getDisplayName

      public String getDisplayName()

      Returns the user-friendly String name of the PreservationMode.

      Specified by:
      getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable
      Returns:
      a user-friendly String representing the PreservationMode object

    • getDisplayDescription

      public String getDisplayDescription()

      Returns the user-friendly String description of the PreservationMode.

      Specified by:
      getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable
      Returns:
      a user-friendly String description representing the PreservationMode object

    • toString

      public String toString()

      Returns a String representation of PreservationMode.

      Overrides:
      toString in class Enum<PreservationMode>
      Returns:
      a String representing the PreservationMode object