Class Escaper (1.43.1)

Version 1.43.1

• 1.45.2 (latest)
• 1.45.1
• 1.44.2
• 1.43.2
• 1.42.3
• 1.41.8

public abstract class Escaper

An 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 "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>".

An Escaper instance is required to be stateless, and safe when used concurrently by multiple threads.

Several popular escapers are defined as constants in the class CharEscapers.

Inheritance

java.lang.Object > Escaper

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Escaper()

public Escaper()

Methods

escape(String string)

public abstract String escape(String string)

Returns the escaped form of a given literal string.

Note that this method may treat input characters differently depending on the specific escaper implementation.

• UnicodeEscaper handles UTF-16 correctly, including surrogate character pairs. If the input is badly formed the escaper should throw IllegalArgumentException.

Parameter
Name	Description
string	String the literal string to be escaped

Returns
Type	Description
String	the escaped form of string