freemarker.ext.misc
Class LegacyCompress

java.lang.Object
  |
  +--freemarker.ext.misc.LegacyCompress
All Implemented Interfaces:
TemplateModel, TemplateTransformModel2

public final class LegacyCompress
extends java.lang.Object
implements TemplateTransformModel2

A re-implementation of the <compress> template instruction as a TemplateTransformModel. This implementation behaves exactly the same way as the compress tag.

Usage:
From java:

 TemplateModelRoot root = new SimpleHash();

 root.put( "compressWhitespace", freemarker.ext.misc.LegacyCompress.getInstance() );

 ...
 

From your FM-Classic template:

 The following is compressed:
 <transform compressWhitespace>
   <p>This paragraph has all whitespace removed.</p>
 </transform>

 ...
 

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

Version:
$Id: LegacyCompress.java,v 1.11 2003/11/17 13:06:24 run2000 Exp $
See Also:
CompressWhitespace

Constructor Summary
LegacyCompress()
          Deprecated. use the getInstance() method to avoid excessive object creation
 
Method Summary
static LegacyCompress getInstance()
          Retrieve a singleton instance of this class.
 boolean isEmpty()
          Is the object empty?
 void transform(java.io.Reader source, java.io.Writer output)
          Re-implementation of the <compress> FM-Classic tag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LegacyCompress

public LegacyCompress()
Deprecated. use the getInstance() method to avoid excessive object creation

Creates new LegacyCompress.
Method Detail

getInstance

public static LegacyCompress 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 LegacyCompress class

transform

public void transform(java.io.Reader source,
                      java.io.Writer output)
               throws java.io.IOException,
                      TemplateModelException
Re-implementation of the <compress> FM-Classic tag.
Specified by:
transform in interface TemplateTransformModel2
Parameters:
source - the input to be transformed
output - the destination of the transformation

isEmpty

public boolean isEmpty()
                throws TemplateModelException
Is the object empty?
Specified by:
isEmpty in interface TemplateModel
Returns:
false, to indicate this object is not empty