Package freemarker.template.utility
Class XmlEscape
java.lang.Object
freemarker.template.utility.XmlEscape
- All Implemented Interfaces:
TemplateModel,TemplateTransformModel
Performs an XML escaping of a given template fragment. Specifically,
< > " ' and & are all turned into entity references.
An instance of this transform is initially visible as shared
variable called xml_escape.
-
Field Summary
Fields inherited from interface freemarker.template.TemplateModel
NOTHING -
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
XmlEscape
public XmlEscape()
-
-
Method Details
-
getWriter
Description copied from interface:TemplateTransformModelReturns 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.This method should not throw
RuntimeException, norIOExceptionthat wasn't caused by writing to the output. Such exceptions should be catched inside the method and wrapped inside aTemplateModelException. (Note that settingConfiguration.setWrapUncheckedExceptions(boolean)totruecan mitigate the negative effects of implementations that throwRuntimeException-s.)- Specified by:
getWriterin interfaceTemplateTransformModel- 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 areTemplateModelinstances. This is nevernull. (If you need to convert the template models to POJOs, you can use the utility methods in theDeepUnwrapclass. Though it's recommended to work withTemplateModel-s directly.)- Returns:
- The
Writerto which the engine will write the content to transform, ornullif the transform does not support nested content (body). The returnedWritermay implements theTransformControlinterface if it needs advanced control over the evaluation of the nested content. FreeMarker will callWriter.close()after the transform end-tag.Writer.close()must not close theWriterreceived as theoutparameter (so if you are using aFilterWriter, you must overrideFilterWriter.close(), as by default that closes the wrappedWriter). Since 2.3.27 its also allowed to return theoutwriter as is, in which case it won't be closed.
-