XmlEscape (FreeMarker 2.3.23 API)
Date: 2015-07-05

freemarker.template.utility

## Class XmlEscape

- java.lang.Object
- - freemarker.template.utility.XmlEscape

- All Implemented Interfaces:
    TemplateModel, TemplateTransformModel

      public class XmlEscape
      extends Object
      implements 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
    Constructor and Description
    `XmlEscape()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Writer` | `getWriter(Writer out, 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`

- - ### Constructor Detail

    - #### XmlEscape

          public XmlEscape()

  - ### Method Detail

    - #### getWriter

          public Writer getWriter(Writer out,
                                  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 output
        `args` - 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. If you need to convert the template models to POJOs, you can use the utility methods in the `DeepUnwrap` class.
      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.