@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.
Several popular escapers are defined as constants in classes like HtmlEscapers
, XmlEscapers
, and SourceCodeEscapers
. To create your own escapers extend this class and implement the escape(char)
method.
Modifier and Type | Method and Description |
---|---|
String |
escape(String string)
Returns the escaped form of a given literal string.
|
asFunction
public String escape(String string)
escape
in class Escaper
string
- the literal string to be escapedstring
NullPointerException
- if string
is nullCopyright © 2010 - 2020 Adobe. All Rights Reserved