Enum Class Mode

java.lang.Object
java.lang.Enum<Mode>
org.simpleframework.xml.stream.Mode
All Implemented Interfaces:
Serializable, Comparable<Mode>, Constable

public enum Mode extends Enum<Mode>
The Mode enumeration is used to specify the output mode for XML text. This is used by the OutputNode to describe if element text will be escaped or wrapped in a CDATA block. The mode is a three state object, the third of the states indicates whether an explicit state has been set or not. If a specific state has not been set then the node will inherit its output mode from the last parent to have it set.
See Also:
  • Enum Constant Details

    • DATA

      public static final Mode DATA
      Indicates that data written will be within a CDATA block.
    • ESCAPE

      public static final Mode ESCAPE
      Indicates that data written will be escaped if required.
    • INHERIT

      public static final Mode INHERIT
      Indicates that the mode will be inherited from its parent.
  • Constructor Details

    • Mode

      private Mode()
  • Method Details

    • values

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