Enum JsonEscapeType

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

    public enum JsonEscapeType
    extends java.lang.Enum<JsonEscapeType>

    Types of escape operations to be performed on JSON text:

    • SINGLE_ESCAPE_CHARS_DEFAULT_TO_UHEXA: Use Single Escape Chars whenever possible (depending on the specified JsonEscapeLevel). For escaped characters that do not have an associated SEC, default to using \uFFFF Hexadecimal Escapes.
    • UHEXA: Replace escaped characters with \uFFFF Hexadecimal Escapes.

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

    Since:
    1.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      SINGLE_ESCAPE_CHARS_DEFAULT_TO_UHEXA
      Use Single Escape Chars if possible, default to \uFFFF hexadecimal escapes.
      UHEXA
      Always use \uFFFF hexadecimal escapes.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean useSECs  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private JsonEscapeType​(boolean useSECs)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) boolean getUseSECs()  
      static JsonEscapeType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JsonEscapeType[] 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

      • SINGLE_ESCAPE_CHARS_DEFAULT_TO_UHEXA

        public static final JsonEscapeType SINGLE_ESCAPE_CHARS_DEFAULT_TO_UHEXA
        Use Single Escape Chars if possible, default to \uFFFF hexadecimal escapes.
      • UHEXA

        public static final JsonEscapeType UHEXA
        Always use \uFFFF hexadecimal escapes.
    • Field Detail

      • useSECs

        private final boolean useSECs
    • Constructor Detail

      • JsonEscapeType

        private JsonEscapeType​(boolean useSECs)
    • Method Detail

      • values

        public static JsonEscapeType[] 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 (JsonEscapeType c : JsonEscapeType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static JsonEscapeType 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
      • getUseSECs

        boolean getUseSECs()