org.apache.velocity.app.event.implement

Class EscapeXmlReference

java.lang.Object

org.apache.velocity.app.event.implement.EscapeReference

org.apache.velocity.app.event.implement.EscapeXmlReference

All Implemented Interfaces:

EventHandler, ReferenceInsertionEventHandler, RuntimeServicesAware

public class EscapeXmlReference
extends EscapeReference

Escape all XML entities, suitable for placing the output inside an XML (1.0) text node or attribute value.

Since:

1.5

Author:

wglass

See Also:

StringEscapeUtils

Field Summary

Fields inherited from class org.apache.velocity.app.event.implement.EscapeReference

log

Constructor Summary

Constructors

Constructor and Description
EscapeXmlReference()

Method Summary

Modifier and Type	Method and Description
protected String	escape(Object text) Escape all XML entities.
protected String	getMatchAttribute() Specify the configuration attribute that specifies the regular expression.

Methods inherited from class org.apache.velocity.app.event.implement.EscapeReference

getRuntimeServices, referenceInsert, setRuntimeServices

Methods inherited from class java.lang.Object

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

Constructor Detail

EscapeXmlReference

public EscapeXmlReference()

Method Detail

escape

protected String escape(Object text)

Escape all XML entities.

Specified by:

escape in class EscapeReference

Parameters:

text -

Returns:

An escaped String.

See Also:

StringEscapeUtils

getMatchAttribute

protected String getMatchAttribute()

Description copied from class: EscapeReference

Specify the configuration attribute that specifies the regular expression. Ideally should be in a form

eventhandler.escape.XYZ.match

where XYZ is the type of escaping being done.

Specified by:

getMatchAttribute in class EscapeReference

Returns:

attribute "eventhandler.escape.xml.match"