sirius.web.templates

Class ContentHelper

java.lang.Object

sirius.web.templates.ContentHelper

public class ContentHelper
extends Object

Provides helper methods used in Velocity Macros.

The instance of this class is made available as helper via DefaultGlobalContextExtender.

Field Summary

Fields

Modifier and Type	Field and Description
static ContentHelper	INSTANCE Contains the instance which is passed into the velocity context as "helper".

Method Summary

Modifier and Type	Method and Description
static String	escapeXML(Object aText) Removes all XML characters (<, >, ", ', &) from the input and replaces it with the well known replacement characters.
String	getResourceAsInlineString(String resource) Returns the contents of the given template as a single line string which can be embedded into a string enclosed by ' (e.g. a JavaScript string).
String	nl2br(String content) Replaces new line with <br> tags.
String	stripXML(String content) Removes all XML tags from a given content.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ContentHelper INSTANCE

Contains the instance which is passed into the velocity context as "helper".

Method Detail

nl2br

public String nl2br(String content)

Replaces new line with <br> tags.

Parameters:

content - the content to parse

Returns:

the value of content where all line breaks are replaced by <br> tags.

escapeXML

@Nonnull
public static String escapeXML(@Nullable
                                        Object aText)

Removes all XML characters (<, >, ", ', &) from the input and replaces it with the well known replacement characters.

Parameters:

aText - the text to replace

Returns:

a string which can safely output in XML or HTML. Returns an empty string if the input was null.

stripXML

public String stripXML(String content)

Removes all XML tags from a given content.

Parameters:

content - content to strip XML of

Returns:

content without XML tags

getResourceAsInlineString

@Nonnull
public String getResourceAsInlineString(String resource)

Returns the contents of the given template as a single line string which can be embedded into a string enclosed by ' (e.g. a JavaScript string).

Parameters:

resource - the template to fetch

Returns:

the contents of the template without line breaks and with escaped ticks ('). If the template cannot be found an empty string is returned