@Beta @GwtCompatible public abstract class CharEscaper extends Escaper
For example, an XML escaper would convert the literal string
"Foo<Bar>" to prevent
"<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
CharEscaper instance is required to be stateless, and safe when used concurrently by
Several popular escapers are defined as constants in classes like
SourceCodeEscapers. To create your own escapers extend this class and implement the
|Modifier||Constructor and Description|
Constructor for use by subclasses.
|Modifier and Type||Method and Description|
Returns the escaped form of the given character, or
Returns the escaped form of a given literal string.
Returns the escaped form of a given literal string, starting at the given index.
protected final String escapeSlow(String s, int index)
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
protected abstract char escape(char c)
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
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
char value, so this method should
not throw any exceptions.
c- the character to escape if necessary
nullif no escaping was needed
Copyright © 2010-2013. All Rights Reserved.