org.jamon.escaping

Interface Escaping

All Known Implementing Classes:

AbstractCharacterEscaping, HtmlEscaping, JavascriptEscaping, NoneEscaping, StrictHtmlEscaping, UrlEscaping, XmlEscaping

public interface Escaping

Converts a string into an escaped version of it. Escaping is the process of converting a string into another string such that

• the process can be inverted (i.e., you can recover the original string from its escaped version), and
• the escaped version is gauranteed to satisfy certain constraints

Typically, the constraints are that a certain set of characters cannot appear in the escaped string.

Examples of escaping mechanisms are HTML escaping, URL escaping.

Field Summary

Fields

Modifier and Type	Field and Description
static Escaping	HTML An escaping mechanism which escapes suitable for inclusion in HTML documents.
static Escaping	JAVASCRIPT An escaping mechanism which escapes suitable for inclusion in in Javascript.
static Escaping	NONE An escaping mechanism which passes through strings without change.
static Escaping	STRICT_HTML An escaping mechanism which escapes suitable for inclusion inside html attributes.
static Escaping	URL An escaping mechanism which escapes suitable for inclusion in URLs.
static Escaping	XML An escaping mechanism which escapes suitable for inclusion in XML documents.

Method Summary

Methods

Modifier and Type	Method and Description
void	write(String string, Writer writer)

Field Detail

HTML

static final Escaping HTML

An escaping mechanism which escapes suitable for inclusion in HTML documents.

STRICT_HTML

static final Escaping STRICT_HTML

An escaping mechanism which escapes suitable for inclusion inside html attributes.

NONE

static final Escaping NONE

An escaping mechanism which passes through strings without change.

URL

static final Escaping URL

An escaping mechanism which escapes suitable for inclusion in URLs.

XML

static final Escaping XML

An escaping mechanism which escapes suitable for inclusion in XML documents.

JAVASCRIPT

static final Escaping JAVASCRIPT

An escaping mechanism which escapes suitable for inclusion in in Javascript. Note that it does not do any HTML escaping.

Method Detail

write

void write(String string,
         Writer writer)
           throws IOException

Throws:

IOException