Class StandardCompress
- All Implemented Interfaces:
TemplateModel,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
FieldsFields inherited from interface freemarker.template.TemplateModel
NOTHING -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
INSTANCE
-
-
Constructor Details
-
StandardCompress
public StandardCompress() -
StandardCompress
public StandardCompress(int defaultBufferSize)- Parameters:
defaultBufferSize- the default amount of characters to buffer
-
-
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. - Throws:
TemplateModelException- If any problem occurs that's not anIOExceptionduring writing the template output.
-