Enum Class XmlEscapeType

Object
Enum<XmlEscapeType>
org.unbescape.xml.XmlEscapeType
All Implemented Interfaces:
Serializable, Comparable<XmlEscapeType>, Constable

public enum XmlEscapeType extends Enum<XmlEscapeType>

Types of escape operations to be performed on XML text:

  • CHARACTER_ENTITY_REFERENCES_DEFAULT_TO_DECIMAL: Replace escaped characters with Character Entity References whenever possible (depending on the specified XmlEscapeLevel), and default to using Decimal Character References for escaped characters that do not have an associated CER.
  • CHARACTER_ENTITY_REFERENCES_DEFAULT_TO_DECIMAL: Replace escaped characters with Character Entity References whenever possible (depending on the specified XmlEscapeLevel), and default to using Hexadecimal Character References for escaped characters that do not have an associated CER.
  • DECIMAL_REFERENCES: Replace escaped characters with Decimal Character References (will never use CER).
  • HEXADECIMAL_REFERENCES: Replace escaped characters with Hexadecimal Character References (will never use CERs).

For further information, see the Glossary and the References sections at the documentation for the XmlEscape class.

Since:
1.0.0
Author:
Daniel Fernández
  • Enum Constant Details

    • CHARACTER_ENTITY_REFERENCES_DEFAULT_TO_DECIMAL

      public static final XmlEscapeType CHARACTER_ENTITY_REFERENCES_DEFAULT_TO_DECIMAL
      Use Character Entity References if possible, default to Decimal Character References.
    • CHARACTER_ENTITY_REFERENCES_DEFAULT_TO_HEXA

      public static final XmlEscapeType CHARACTER_ENTITY_REFERENCES_DEFAULT_TO_HEXA
      Use Character Entity Referencess if possible, default to Hexadecimal Character References.
    • DECIMAL_REFERENCES

      public static final XmlEscapeType DECIMAL_REFERENCES
      Always use Decimal Character References (no CERs will be used).
    • HEXADECIMAL_REFERENCES

      public static final XmlEscapeType HEXADECIMAL_REFERENCES
      Always use Hexadecimal Character References (no CERs will be used).
  • Method Details

    • values

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