- Direct Known Subclasses:
@Beta @GwtCompatible public abstract class CharEscaper extends EscaperAn object that converts literal text into a format safe for inclusion in a particular context (such as an XML document). Typically (but not always), the inverse process of "unescaping" the text is performed automatically by the relevant parser.
For example, an XML escaper would convert the literal string
"<Bar>"from being confused with an XML tag. When the resulting XML document is parsed, the parser API will return this text as the original literal string
CharEscaperinstance is required to be stateless, and safe when used concurrently by multiple threads.
- Sven Mawson
Constructors Modifier Constructor Description
CharEscaper()Constructor for use by subclasses.
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description
protected abstract char
escape(char c)Returns the escaped form of the given character, or
nullif this character does not need to be escaped.
escape(String string)Returns the escaped form of a given literal string.
escapeSlow(String s, int index)Returns the escaped form of a given literal string, starting at the given index.
protected CharEscaper()Constructor for use by subclasses.
escapeReturns the escaped form of a given literal string.
@CheckForNull protected abstract char escape(char c)Returns the escaped form of the given character, or
nullif this character does not need to be escaped. If an empty array is returned, this effectively strips the input character from the resulting text.
If the character does not need to be escaped, this method should return
null, rather than a one-character array containing the character itself. This enables the escaping algorithm to perform more efficiently.
An escaper is expected to be able to deal with any
charvalue, so this method should not throw any exceptions.
c- the character to escape if necessary
- the replacement characters, or
nullif no escaping was needed
protected final String escapeSlow(String s, int index)Returns the escaped form of a given literal string, starting at the given index. This method is called by the
escape(String)method when it discovers that escaping is required. It is protected to allow subclasses to override the fastpath escaping function to inline their escaping test. See
CharEscaperBuilderfor an example usage.
s- the literal string to be escaped
index- the index to start escaping from
- the escaped form of