public abstract class

CharacterEscapes

extends Object
java.lang.Object
   ↳ com.fasterxml.jackson.core.io.CharacterEscapes

Class Overview

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.

Summary

Constants
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.
int ESCAPE_NONE Value used for lookup tables to indicate that matching characters do not need to be escaped.
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.
Public Constructors
CharacterEscapes()
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

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.

Constant Value: -2 (0xfffffffe)

public static final int ESCAPE_NONE

Value used for lookup tables to indicate that matching characters do not need to be escaped.

Constant Value: 0 (0x00000000)

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.

Constant Value: -1 (0xffffffff)

Public Constructors

public CharacterEscapes ()

Public Methods

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.

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.

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()