Enum XmlEscapeType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<XmlEscapeType>

    public enum XmlEscapeType
    extends java.lang.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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean useCERs  
      private boolean useHexa  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private XmlEscapeType​(boolean useCERs, boolean useHexa)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) boolean getUseCERs()  
      (package private) boolean getUseHexa()  
      static XmlEscapeType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static XmlEscapeType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • 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).
    • Field Detail

      • useCERs

        private final boolean useCERs
      • useHexa

        private final boolean useHexa
    • Constructor Detail

      • XmlEscapeType

        private XmlEscapeType​(boolean useCERs,
                              boolean useHexa)
    • Method Detail

      • values

        public static XmlEscapeType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (XmlEscapeType c : XmlEscapeType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static XmlEscapeType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getUseCERs

        boolean getUseCERs()
      • getUseHexa

        boolean getUseHexa()