Package com.deltaxml.dita.config

Enum Class ModifiedAttributeMode

java.lang.Object
java.lang.Enum<ModifiedAttributeMode>
com.deltaxml.dita.config.ModifiedAttributeMode
All Implemented Interfaces:
com.deltaxml.dita.DitaCompareDisplayable, Serializable, Comparable<ModifiedAttributeMode>, Constable
public enum ModifiedAttributeMode extends Enum<ModifiedAttributeMode> implements com.deltaxml.dita.DitaCompareDisplayable
Defined the modified attribute processing mode.

  • Enum Constant Details

    • AUTOMATIC

      public static final ModifiedAttributeMode AUTOMATIC
      The behaviour will depend on other parameter settings, primarily the output-format. If the output format is able to show attribute changes, modified attributes will not be processed differently, otherwise 'B' mode will be chosen.

    • DOCUMENT_B

      public static final ModifiedAttributeMode DOCUMENT_B
      Output the 'B' version of modified attributes and any added ('B') attributes. Note that deleted ('A') attributes will not be output.

    • DOCUMENT_B_THEN_A

      public static final ModifiedAttributeMode DOCUMENT_B_THEN_A
      Output the 'B' version of modified attributes. Output both inserted ('B') and deleted ('A') attributes.

    • DOCUMENT_A

      public static final ModifiedAttributeMode DOCUMENT_A
      Output the 'A' version of modified attributes and any deleted ('A') attributes. Note that added ('B') attributes will not be output.

    • DOCUMENT_A_THEN_B

      public static final ModifiedAttributeMode DOCUMENT_A_THEN_B
      Output the 'A' version of modified attributes. Output both inserted ('B') and deleted ('A') attributes.

    • ENCODE_AS_ATTRIBUTES

      public static final ModifiedAttributeMode ENCODE_AS_ATTRIBUTES
      Output the 'B' version of modified attributes and any added ('B') attributes but additionally show the changes encoded as attributes in the attribute-change ('ac') namespace.

  • Method Details

    • values

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

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

    • getDisplayDescription

      public String getDisplayDescription()

      Returns the user-friendly String description of the ModifiedAttributeMode.

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

    • toString

      public String toString()

      Returns a String representation of ModifiedAttributeMode.

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