com.communote.common.velocity

Class EscapeTool

java.lang.Object

org.apache.velocity.tools.generic.SafeConfig

org.apache.velocity.tools.generic.EscapeTool

com.communote.common.velocity.EscapeTool

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

Extended version of the generic velocity escape tool that provides some additional escape functions.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

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

DEFAULT_KEY

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig

LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY

Constructor Summary

Constructors

Constructor and Description
EscapeTool()

Method Summary

Modifier and Type	Method and Description
String	escapeQuote(Object string) Escapes the double quotes in a string with a backslash.
String	escapeSingleQuote(Object string) Escapes the single quotes in a string with a backslash.
String	javascriptInline(Object string) Exposes StringEscapeHelper.escapeJavaScriptInlineHtml(String) to the Velocity engine.
String	javascriptSimple(Object string) Escapes only single and double quotes with a backslash.
String	jsonInline(Object string) Exposes StringEscapeHelper.escapeJsonInlineHtml(String) to the Velocity engine.
String	nonWordChars(Object string) Exposes StringEscapeHelper.escapeNonWordCharacters(String) to velocity templates.
String	xmlSimple(Object string) Simple version of XML escaping which delegates to StringEscapeHelper.escapeXml(String).

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

configure, dumpString, getB, getBackslash, getD, getDollar, getE, getExclamation, getH, getHash, getKey, getN, getNewline, getQ, getQuote, getS, getSingleQuote, html, java, javascript, propertyKey, propertyValue, setKey, sql, unicode, url, velocity, xml

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

configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

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

escapeQuote

public String escapeQuote(Object string)

Escapes the double quotes in a string with a backslash.

Parameters:

string - string to escape

Returns:

the escaped string

escapeSingleQuote

public String escapeSingleQuote(Object string)

Escapes the single quotes in a string with a backslash.

Parameters:

string - the string to escape

Returns:

the escaped string

javascriptInline

public String javascriptInline(Object string)

Exposes StringEscapeHelper.escapeJavaScriptInlineHtml(String) to the Velocity engine.

Parameters:

string - the string to escape

Returns:

the escaped string

See Also:

StringEscapeHelper.escapeJavaScriptInlineHtml(String)

javascriptSimple

public String javascriptSimple(Object string)

Escapes only single and double quotes with a backslash.

Parameters:

string - string to escape

Returns:

the escaped string

jsonInline

public String jsonInline(Object string)

Exposes StringEscapeHelper.escapeJsonInlineHtml(String) to the Velocity engine.

Parameters:

string - the serialized JSON string to escape

Returns:

the escaped string

See Also:

StringEscapeHelper.escapeJsonInlineHtml(String)

nonWordChars

public String nonWordChars(Object string)

Exposes StringEscapeHelper.escapeNonWordCharacters(String) to velocity templates.

Parameters:

string - the string to escape

Returns:

the escaped string

See Also:

StringEscapeHelper.escapeNonWordCharacters(String)

xmlSimple

public String xmlSimple(Object string)

Simple version of XML escaping which delegates to StringEscapeHelper.escapeXml(String).

Parameters:

string - string to escape

Returns:

the escaped string