Escaper

java.lang.Object
- com.google.api.client.util.escape.Escaper

Direct Known Subclasses:

UnicodeEscaper
```
public abstract class Escaper
extends java.lang.Object
```
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.

Since:

1.0

Constructor Summary

Constructors
Constructor Description

Escaper()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`escape(java.lang.String string)`	Returns the escaped form of a given literal string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Escaper
```
public Escaper()
```
- Method Detail
  - escape
```
public abstract java.lang.String escape(java.lang.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.
    Parameters:
    
    string - the literal string to be escaped
    
    Returns:
    
    the escaped form of string
    
    Throws:
    
    java.lang.NullPointerException - if string is null
    
    java.lang.IllegalArgumentException - if string contains badly formed UTF-16 or cannot be escaped for any other reason