org.xwiki.velocity.tools
Class EscapeTool

java.lang.Object
  org.apache.velocity.tools.generic.EscapeTool
      org.xwiki.velocity.tools.EscapeTool

public class EscapeTool
extends org.apache.velocity.tools.generic.EscapeTool

Tool for working with escaping in Velocity templates. It provides methods to escape outputs for Velocity, Java, JavaScript, HTML, XML and SQL.

Extends the default EscapeTool from velocity-tools since the XML escape performed by it doesn't work inside HTML content, since apos is not a valid HTML entity name, and it always escapes non-ASCII characters, which increases the HTML length considerably, while also making the source unreadable.

Since:

2.7RC1

Version:

$Id: 55ac748f052d45de42bdab41aff4cbf6897a542f $

Constructor Summary

EscapeTool()

Method Summary

String	b(Object content) Encode a text using the B encoding specified in RFC 2047.
String	q(Object content) Encode a text using the Q encoding specified in RFC 2047.
String	quotedPrintable(Object content) Encode a text using the Quoted-Printable format, as specified in section 6.7 of RFC 2045.
String	url(Map<String,?> parametersMap) Properly escape a parameter map representing a query string, so that it can be safely used in an URL.
String	xml(Object content) Escapes the XML special characters in a String using numerical XML entities.

Methods inherited from class org.apache.velocity.tools.generic.EscapeTool

dumpString, getB, getBackslash, getD, getDollar, getE, getExclamation, getH, getHash, getQ, getQuote, getS, getSingleQuote, html, java, javascript, propertyKey, propertyValue, sql, url

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EscapeTool

public EscapeTool()

Method Detail

xml

public String xml(Object content)

Escapes the XML special characters in a String using numerical XML entities.

Overrides:

xml in class org.apache.velocity.tools.generic.EscapeTool

Parameters:

content - the text to escape, may be null

Returns:

a new escaped String, null if null input

quotedPrintable

public String quotedPrintable(Object content)

Encode a text using the Quoted-Printable format, as specified in section 6.7 of RFC 2045. UTF-8 is used as the character encoding, and no line breaking is performed.

Parameters:

content - the text to encode

Returns:

the text converted into the Quoted-Printable format

q

public String q(Object content)

Encode a text using the Q encoding specified in RFC 2047. UTF-8 is used as the character encoding, and no line breaking is performed. The resulting text is already wrapped with the encoded word markers, starting with =?UTF-8?Q? and ending with ?=.

Parameters:

content - the text to encode

Returns:

the text converted into an encoded word using the Q encoding

b

public String b(Object content)

Encode a text using the B encoding specified in RFC 2047. UTF-8 is used as the character encoding, and no line breaking is performed. The resulting text is already wrapped with the encoded word markers, starting with =?UTF-8?B? and ending with ?=.

Parameters:

content - the text to encode

Returns:

the text converted into an encoded word using the B encoding

url

public String url(Map<String,?> parametersMap)

Properly escape a parameter map representing a query string, so that it can be safely used in an URL. Parameters can have multiple values in which case the value in the map is either an array or a Collection. If the parameter name is null (the key is null) then the parameter is ignored. null values are serialized as an empty string.

Parameters:

parametersMap - Map representing the query string.

Returns:

the safe query string representing the passed parameters

Since:

5.2M1