Enum JavaScriptEscapeType

java.lang.Object
java.lang.Enum<JavaScriptEscapeType>
org.unbescape.javascript.JavaScriptEscapeType
All Implemented Interfaces:
Serializable, Comparable<JavaScriptEscapeType>, java.lang.constant.Constable

public enum JavaScriptEscapeType extends Enum<JavaScriptEscapeType>

Types of escape operations to be performed on JavaScript text:

  • SINGLE_ESCAPE_CHARS_DEFAULT_TO_XHEXA_AND_UHEXA: Use Single Escape Chars whenever possible (depending on the specified JavaScriptEscapeLevel). For escaped characters that do not have an associated SEC, default to using \xFF Hexadecimal Escapes if possible (characters <= U+00FF), then default to \uFFFF Hexadecimal Escapes. This type of escape produces the smallest escaped string possible.
  • SINGLE_ESCAPE_CHARS_DEFAULT_TO_UHEXA: Use Single Escape Chars whenever possible (depending on the specified JavaScriptEscapeLevel). For escaped characters that do not have an associated SEC, default to using \uFFFF Hexadecimal Escapes.
  • XHEXA_DEFAULT_TO_UHEXA: Replace escaped characters with \xFF Hexadecimal Escapes if possible (characters <= U+00FF), default to \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 JavaScriptEscape class.

Since:
1.0.0
  • Enum Constant Details

    • SINGLE_ESCAPE_CHARS_DEFAULT_TO_XHEXA_AND_UHEXA

      public static final JavaScriptEscapeType SINGLE_ESCAPE_CHARS_DEFAULT_TO_XHEXA_AND_UHEXA
      Use Single Escape Chars if possible, default to \xFF hexadecimal escapes if possible (characters <= U+FF), then default to \uFFFF hexadecimal escapes.
    • SINGLE_ESCAPE_CHARS_DEFAULT_TO_UHEXA

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

      public static final JavaScriptEscapeType XHEXA_DEFAULT_TO_UHEXA
      Use \xFF hexadecimal escapes if possible (characters <= U+FF), default to \uFFFF hexadecimal escapes.
    • UHEXA

      public static final JavaScriptEscapeType UHEXA
      Always use \uFFFF hexadecimal escapes.
  • Field Details

    • useSECs

      private final boolean useSECs
    • useXHexa

      private final boolean useXHexa
  • Constructor Details

    • JavaScriptEscapeType

      private JavaScriptEscapeType(boolean useSECs, boolean useXHexa)
  • Method Details

    • values

      public static JavaScriptEscapeType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static JavaScriptEscapeType valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getUseSECs

      boolean getUseSECs()
    • getUseXHexa

      boolean getUseXHexa()