freemarker.ext.misc
Class Transforms

java.lang.Object
  freemarker.ext.misc.Transforms

All Implemented Interfaces:

TemplateHashModel, TemplateModel, java.io.Serializable

public final class Transforms
extends java.lang.Object
implements TemplateHashModel, java.io.Serializable

A simple hash model that provides access to all the non-deprecated transform models in this package.

The keys are as follows:

• chain -- the Pipeline transform
• compress -- the CompressWhitespace transform
• freemarkerToHtml -- the FreeMarkerToHtml transform
• htmlEscape -- the HtmlEscape transform
• javaToHtml -- the JavaToHtml transform
• legacyCompress -- the LegacyCompress transform
• normalizeNewlines -- the NormalizeNewlines transform
• pipeline -- the Pipeline transform
• removeBlankLines -- the RemoveBlankLines transform
• substitute -- the Perl5Substitute transform
• translate -- the Perl5Translate transform
• xmlEscape -- the XmlEscape transform

Usage:
From java:

 TemplateModelRoot root = new SimpleHash();

 root.put( "transforms", freemarker.ext.misc.Transforms.getInstance() );

 ...
 

From your FM-Classic template:

 The following is compressed:
 <transform transforms.compressWhitespace>
   <p>This paragraph has all whitespace reduced to a single
   space character.</p>
 </transform>

 ...
 

Note:
Transforms is a singleton instance. Use the getInstance() method to retrieve instances of this model.

Since:

1.8.1

Version:

$Id: Transforms.java 1101 2013-04-01 04:17:32Z run2000 $

Author:

Nicholas Cull

See Also:

Serialized Form

Method Summary

TemplateModel	get(java.lang.String key) Gets a TemplateModel from the hash.
static Transforms	getInstance() Retrieve a singleton instance of this class.
boolean	isEmpty() Is the object empty?

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Transforms getInstance()

Retrieve a singleton instance of this class. Since there is no state information held between calls, there is only a need for one instance.

Returns:

an instance of this Transforms class

isEmpty

public boolean isEmpty()
                throws TemplateModelException

Is the object empty?

Specified by:

isEmpty in interface TemplateModel

Returns:

false to indicate that this model is non-empty

Throws:

TemplateModelException

get

public TemplateModel get(java.lang.String key)
                  throws TemplateModelException

Gets a TemplateModel from the hash.

Specified by:

get in interface TemplateHashModel

Parameters:

key - the name by which the TemplateModel is identified in the template.

Returns:

the TemplateModel referred to by the key, or null if not found.

Throws:

TemplateModelException - there was a problem getting the value for the given key