@Beta @GwtCompatible public abstract class CharEscaper extends Escaper
For example, an XML escaper would convert the literal string "Foo<Bar>" into "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
string "Foo<Bar>".
A CharEscaper instance is required to be stateless, and safe when used concurrently by
multiple threads.
Popular escapers are defined as constants in classes like HtmlEscapers and XmlEscapers.
To create your own escapers extend this class and implement the escape(char) method.
| Modifier | Constructor and Description |
|---|---|
protected |
CharEscaper()
Constructor for use by subclasses.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract char[] |
escape(char c)
Returns the escaped form of the given character, or
null if this character does not
need to be escaped. |
String |
escape(String string)
Returns the escaped form of a given literal string.
|
protected String |
escapeSlow(String s,
int index)
Returns the escaped form of a given literal string, starting at the given index.
|
asFunctionprotected CharEscaper()
public String escape(String string)
escape in class Escaperstring - the literal string to be escapedstringNullPointerException - if string is nullprotected 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 CharEscaperBuilder for an example usage.s - the literal string to be escapedindex - the index to start escaping fromstringNullPointerException - if string is nullprotected abstract char[] escape(char c)
null if 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 char value, so this method should
not throw any exceptions.
c - the character to escape if necessarynull if no escaping was neededCopyright © 2010-2015. All Rights Reserved.