Package com.deltaxml.dita.config

Enum Class MapResultStructure

java.lang.Object
java.lang.Enum<MapResultStructure>
com.deltaxml.dita.config.MapResultStructure
All Implemented Interfaces:
com.deltaxml.dita.DitaCompareDisplayable, Serializable, Comparable<MapResultStructure>, Constable
public enum MapResultStructure extends Enum<MapResultStructure> implements com.deltaxml.dita.DitaCompareDisplayable
Enumeration representing how the result map is constructed.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    MAP_PAIR
    The result map contains two submaps: the 'updated' result origin map (and submaps); and the 'missing' topic references map.
    TOPIC_SET
    The result map will contain a flat list of topic references that appear in the order that they were first encountered in the result origin.
    UNIFIED_MAP
    The result map contains: the 'updated' result origin map; and also includes deleted topic references in positions as close as possible their original location.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayDescription()
    Returns the user-friendly String description of the MapResultStructure.
    String
    getDisplayName()
    Returns the user-friendly String name of the MapResultStructure.
    String
    toString()
    Returns a String representation of MapResultStructure.
    static MapResultStructure
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MapResultStructure[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • TOPIC_SET

      public static final MapResultStructure TOPIC_SET
      The result map will contain a flat list of topic references that appear in the order that they were first encountered in the result origin.

    • MAP_PAIR

      public static final MapResultStructure MAP_PAIR
      The result map contains two submaps: the 'updated' result origin map (and submaps); and the 'missing' topic references map.

    • UNIFIED_MAP

      public static final MapResultStructure UNIFIED_MAP
      The result map contains: the 'updated' result origin map; and also includes deleted topic references in positions as close as possible their original location.

  • Method Details

    • values

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

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

    • getDisplayDescription

      public String getDisplayDescription()

      Returns the user-friendly String description of the MapResultStructure.

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

    • toString

      public String toString()

      Returns a String representation of MapResultStructure.

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