freemarker.template.utility
Class XmlEscape
java.lang.Object
freemarker.template.utility.XmlEscape
- All Implemented Interfaces:
- TemplateModel, TemplateTransformModel
- public class XmlEscape
- extends java.lang.Object
- implements TemplateTransformModel
Performs an XML escape of a given template fragment. Specifically,
< > " ' and & are all turned into entities.
Usage:
From java:
SimpleHash root = new SimpleHash();
root.put( "xmlEscape", new freemarker.template.utility.XmlEscape() );
...
From your FreeMarker template:
The following is XML-escaped:
<transform xmlEscape>
<p>This paragraph has all XML special characters escaped.</p>
</transform>
...
- Version:
- $Id: XmlEscape.java,v 1.28 2003/02/25 00:28:18 revusky Exp $
Method Summary |
java.io.Writer |
getWriter(java.io.Writer out,
java.util.Map args)
Returns a writer that will be used by the engine to feed the
transformation input to the transform. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
XmlEscape
public XmlEscape()
getWriter
public java.io.Writer getWriter(java.io.Writer out,
java.util.Map args)
- Description copied from interface:
TemplateTransformModel
- Returns a writer that will be used by the engine to feed the
transformation input to the transform. Each call to this method
must return a new instance of the writer so that the transformation
is thread-safe.
- Specified by:
getWriter
in interface TemplateTransformModel
- Parameters:
out
- the character stream to which to write the transformed outputargs
- the arguments (if any) passed to the transformation as a
map of key/value pairs where the keys are strings and the arguments are
TemplateModel instances. This is never null.
- Returns:
- a writer to which the engine will feed the transformation
input, or null if the transform does not support nested content (body).
The returned writer can implement the
TransformControl
interface if it needs advanced control over the evaluation of the
transformation body.