@Beta @GwtCompatible public abstract class Escaper extends Object
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
Escaper instance is required to be stateless, and safe when used concurrently by
Because, in general, escaping operates on the code points of a string and not on its
char values, it is not safe to assume that
escape(s) is equivalent to
escape(s.substring(0, n)) + escape(s.substing(n)) for arbitrary
n. This is
because of the possibility of splitting a surrogate pair. The only case in which it is safe to
escape strings and concatenate the results is if you can rule out this possibility, either by
splitting an existing long string into short strings adaptively around surrogate pairs, or by starting
with short strings already known to be free of unpaired surrogates.
The two primary implementations of this interface are
UnicodeEscaper. They are heavily optimized for performance and greatly simplify the task of
implementing new escapers. It is strongly recommended that when implementing a new escaper you
extend one of these classes. If you find that you are unable to achieve the desired behavior
using either of these classes, please contact the Java libraries team for advice.
Several popular escapers are defined as constants in classes like
SourceCodeEscapers. To create your own escapers, use
CharEscaperBuilder, or extend
|Modifier||Constructor and Description|
Constructor for use by subclasses.
|Modifier and Type||Method and Description|
Returns the escaped form of a given literal string.
Note that this method may treat input characters differently depending on the specific escaper implementation.
UnicodeEscaperhandles UTF-16 correctly, including surrogate character pairs. If the input is badly formed the escaper should throw
CharEscaperhandles Java characters independently and does not verify the input for well formed characters. A
CharEscapershould not be used in situations where input is not guaranteed to be restricted to the Basic Multilingual Plane (BMP).
Copyright © 2010-2013. All Rights Reserved.