Module org.apache.wicket.core

Package org.apache.wicket.util.template

Class PackageTextTemplate

java.lang.Object

org.apache.wicket.util.resource.AbstractResourceStream

org.apache.wicket.util.resource.AbstractStringResourceStream

org.apache.wicket.util.template.TextTemplate

org.apache.wicket.util.template.PackageTextTemplate

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, IClusterable, IResourceStream, IStringResourceStream, IModifiable

public class PackageTextTemplate
extends TextTemplate

A String resource that can be appended to.

Since:

1.2.6

Author:

Eelco Hillenius

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONTENT_TYPE	The content type used if not provided in the constructor
static final String	DEFAULT_ENCODING	The encoding used if not provided in the constructor

Constructor Summary

Constructors

Constructor	Description
PackageTextTemplate(Class<?> clazz, String fileName)	Constructor.
PackageTextTemplate(Class<?> clazz, String fileName, String contentType)	Constructor.
PackageTextTemplate(Class<?> clazz, String fileName, String contentType, String encoding)	Constructor.
PackageTextTemplate(Class<?> clazz, String fileName, String style, String variation, Locale locale, String contentType, String encoding)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getString()	Retrieves the String resource.
final TextTemplate	interpolate(Map<String,?> variables)	Interpolates a Map of variables with the content and replaces the content with the result.
void	setEncoding(String encoding)
void	setLocale(Locale locale)	This method shouldn't be used from the outside.
void	setStyle(String style)	This method shouldn't be used from the outside.
void	setVariation(String variation)	This method shouldn't be used from the outside.

Methods inherited from class org.apache.wicket.util.template.TextTemplate

asString, asString

Methods inherited from class org.apache.wicket.util.resource.AbstractStringResourceStream

close, getCharset, getContentType, getInputStream, lastModifiedTime, length, setCharset, setLastModified

Methods inherited from class org.apache.wicket.util.resource.AbstractResourceStream

getLocale, getStyle, getVariation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.util.resource.IResourceStream

getLocale, getStyle, getVariation

Field Details

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

The content type used if not provided in the constructor

See Also:

• Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

The encoding used if not provided in the constructor

Constructor Details

PackageTextTemplate

public PackageTextTemplate(Class<?> clazz,
 String fileName)

Constructor.

Parameters:

clazz - the Class to be used for retrieving the classloader for loading the PackagedTextTemplate

fileName - the name of the file, relative to the clazz position

PackageTextTemplate

public PackageTextTemplate(Class<?> clazz,
 String fileName,
 String contentType)

Constructor.

Parameters:

clazz - the Class to be used for retrieving the classloader for loading the PackagedTextTemplate

fileName - the name of the file, relative to the clazz position

contentType - the mime type of this resource, such as "image/jpeg" or " text/html"

PackageTextTemplate

public PackageTextTemplate(Class<?> clazz,
 String fileName,
 String contentType,
 String encoding)

Constructor.

Parameters:

clazz - the Class to be used for retrieving the classloader for loading the PackagedTextTemplate

fileName - the name of the file, relative to the clazz position

contentType - the mime type of this resource, such as "image/jpeg" or " text/html"

encoding - the file's encoding, for example, "UTF-8"

PackageTextTemplate

public PackageTextTemplate(Class<?> clazz,
 String fileName,
 String style,
 String variation,
 Locale locale,
 String contentType,
 String encoding)

Constructor.

Parameters:

clazz - the Class to be used for retrieving the classloader for loading the PackagedTextTemplate

fileName - the name of the file, relative to the clazz position

style - Any resource style, such as a skin style (see Session)

variation - The template's variation (of the style)

locale - The locale of the resource to load

contentType - the mime type of this resource, such as "image/jpeg" or " text/html"

encoding - the file's encoding, for example, "UTF-8"

Method Details

setStyle

public void setStyle(String style)

Description copied from interface: IResourceStream

This method shouldn't be used from the outside. It is used by the Loaders to set the resolved Style.

Specified by:

setStyle in interface IResourceStream

Overrides:

setStyle in class AbstractResourceStream

Parameters:

style - The style where this stream did resolve to.

setLocale

public void setLocale(Locale locale)

Description copied from interface: IResourceStream

This method shouldn't be used from the outside. It is used by the Loaders to set the resolved locale.

Specified by:

setLocale in interface IResourceStream

Overrides:

setLocale in class AbstractResourceStream

Parameters:

locale - The Locale where this stream did resolve to.

setVariation

public void setVariation(String variation)

Description copied from interface: IResourceStream

This method shouldn't be used from the outside. It is used by the Loaders to set the resolved variation.

Specified by:

setVariation in interface IResourceStream

Overrides:

setVariation in class AbstractResourceStream

Parameters:

variation - The Variation where this stream did resolve to.

setEncoding

public void setEncoding(String encoding)

getString

public String getString()

Description copied from class: TextTemplate

Retrieves the String resource.

Specified by:

getString in class TextTemplate

Returns:

the String resource

See Also:

• AbstractStringResourceStream.getString()

interpolate

public final TextTemplate interpolate(Map<String,?> variables)

Interpolates a Map of variables with the content and replaces the content with the result. Variables are denoted in the String by the syntax ${variableName}. The contents will be altered by replacing each variable of the form ${variableName} with the value returned by variables.getValue("variableName").

WARNING: there is no going back to the original contents after the interpolation is done. If you need to do different interpolations on the same original contents, use the method TextTemplate.asString(Map) instead.

Specified by:

interpolate in class TextTemplate

Parameters:

variables - a Map of variables to interpolate

Returns:

this for chaining