Package com.fasterxml.jackson.core.io

Class CharacterEscapes

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    JsonpCharacterEscapes
    public abstract class CharacterEscapes
extends java.lang.Object
implements java.io.Serializable
    Abstract base class that defines interface for customizing character escaping aspects for String values, for formats that use escaping. For JSON this applies to both property names and String values.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ESCAPE_CUSTOM
      Value used for lookup tables to indicate that matching characters will need custom escapes; and that another call to getEscapeSequence(int) is needed to figure out exact escape sequence to output.
      static int ESCAPE_NONE
      Value used for lookup tables to indicate that matching characters do not need to be escaped.
      static int ESCAPE_STANDARD
      Value used for lookup tables to indicate that matching characters are to be escaped using standard escaping; for JSON this means (for example) using "backslash - u" escape method.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract int[] getEscapeCodesForAscii()
      Method generators can call to get lookup table for determining escape handling for first 128 characters of Unicode (ASCII characters.
      abstract SerializableString getEscapeSequence​(int ch)
      Method generators can call to get lookup table for determining exact escape sequence to use for given character.
      static int[] standardAsciiEscapesForJSON()
      Helper method that can be used to get a copy of standard JSON escape definitions; this is useful when just wanting to slightly customize definitions.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • ESCAPE_NONE

        public static final int ESCAPE_NONE
        Value used for lookup tables to indicate that matching characters do not need to be escaped.
        See Also:
        Constant Field Values

      • ESCAPE_STANDARD

        public static final int ESCAPE_STANDARD
        Value used for lookup tables to indicate that matching characters are to be escaped using standard escaping; for JSON this means (for example) using "backslash - u" escape method.
        See Also:
        Constant Field Values

      • ESCAPE_CUSTOM

        public static final int ESCAPE_CUSTOM
        Value used for lookup tables to indicate that matching characters will need custom escapes; and that another call to getEscapeSequence(int) is needed to figure out exact escape sequence to output.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CharacterEscapes

        public CharacterEscapes()

    • Method Detail

      • getEscapeCodesForAscii

        public abstract int[] getEscapeCodesForAscii()
        Method generators can call to get lookup table for determining escape handling for first 128 characters of Unicode (ASCII characters. Caller is not to modify contents of this array, since this is expected to be a shared copy.
        Returns:
        Array with size of at least 128, where first 128 entries have either one of ESCAPE_xxx constants, or non-zero positive integer (meaning of which is data format specific; for JSON it means that combination of backslash and character with that value is to be used) to indicate that specific escape sequence is to be used.

      • getEscapeSequence

        public abstract SerializableString getEscapeSequence​(int ch)
        Method generators can call to get lookup table for determining exact escape sequence to use for given character. It can be called for any character, but typically is called for either for ASCII characters for which custom escape sequence is needed; or for any non-ASCII character.
        Parameters:
        ch - Character to look escape sequence for
        Returns:
        Escape sequence to use for the character, if any; null if not

      • standardAsciiEscapesForJSON

        public static int[] standardAsciiEscapesForJSON()
        Helper method that can be used to get a copy of standard JSON escape definitions; this is useful when just wanting to slightly customize definitions. Caller can modify this array as it sees fit and usually returns modified instance via getEscapeCodesForAscii()
        Returns:
        Set of escapes, similar to getEscapeCodesForAscii() (array of 128 ints), but a copy that caller owns and is free to modify