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>
Modifier and Type | Field and Description |
---|---|
static StandardCompress |
INSTANCE |
NOTHING
Constructor and Description |
---|
StandardCompress() |
StandardCompress(int defaultBufferSize) |
Modifier and Type | Method and 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.
|
public static final StandardCompress INSTANCE
public StandardCompress()
public StandardCompress(int defaultBufferSize)
defaultBufferSize
- the default amount of characters to bufferpublic java.io.Writer getWriter(java.io.Writer out, java.util.Map args) throws TemplateModelException
TemplateTransformModel
This method should not throw RuntimeException
, nor IOException
that wasn't caused by writing to
the output. Such exceptions should be catched inside the method and wrapped inside a
TemplateModelException
. (Note that setting Configuration.setWrapUncheckedExceptions(boolean)
to
true
can mitigate the negative effects of implementations that throw RuntimeException
-s.)
getWriter
in interface TemplateTransformModel
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 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. Though it's recommended to work with TemplateModel
-s directly.)Writer
to which the engine will write the content to transform, or null
if the
transform does not support nested content (body). The returned Writer
may implements the
TransformControl
interface if it needs advanced control over the evaluation of the nested
content. FreeMarker will call Writer.close()
after the transform end-tag. Writer.close()
must not close the Writer
received as the out
parameter (so if you are using a
FilterWriter
, you must override FilterWriter.close()
, as by default that closes the
wrapped Writer
). Since 2.3.27 its also allowed to return the out
writer as is, in which
case it won't be closed.TemplateModelException
- If any problem occurs that's not an IOException
during writing the template output.