Class StandardCompress
- java.lang.Object
-
- freemarker.template.utility.StandardCompress
-
- All Implemented Interfaces:
TemplateModel
,TemplateTransformModel
public class StandardCompress extends java.lang.Object implements TemplateTransformModel
A filter that compresses each sequence of consecutive whitespace to a single line break (if the sequence contains a line break) or a single space. In addition, leading and trailing whitespace is completely removed.
Specify the transform parameter
single_line = true
to always compress to a single space instead of a line break.The default buffer size can be overridden by specifying a
buffer_size
transform parameter (in bytes).Note: The compress tag is implemented using this filter
Usage:
From java:SimpleHash root = new SimpleHash(); root.put( "standardCompress", new freemarker.template.utility.StandardCompress() ); ...
From your FreeMarker template:
<transform standardCompress> <p>This paragraph will have extraneous whitespace removed.</p> </transform>
Output:
<p>This paragraph will have extraneous whitespace removed.</p>
-
-
Field Summary
Fields Modifier and Type Field Description static StandardCompress
INSTANCE
-
Fields inherited from interface freemarker.template.TemplateModel
NOTHING
-
-
Constructor Summary
Constructors Constructor Description StandardCompress()
StandardCompress(int defaultBufferSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.
-
-
-
Field Detail
-
INSTANCE
public static final StandardCompress INSTANCE
-
-
Method Detail
-
getWriter
public java.io.Writer getWriter(java.io.Writer out, java.util.Map args) throws TemplateModelException
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.This method should not throw
RuntimeException
, norIOException
that 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)
totrue
can mitigate the negative effects of implementations that throwRuntimeException
-s.)- Specified by:
getWriter
in 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 areTemplateModel
instances. This is nevernull
. (If you need to convert the template models to POJOs, you can use the utility methods in theDeepUnwrap
class. Though it's recommended to work withTemplateModel
-s directly.)- Returns:
- The
Writer
to which the engine will write the content to transform, ornull
if the transform does not support nested content (body). The returnedWriter
may implements theTransformControl
interface 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 theWriter
received as theout
parameter (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 theout
writer as is, in which case it won't be closed. - Throws:
TemplateModelException
- If any problem occurs that's not anIOException
during writing the template output.
-
-