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:
java.io.Closeable
,java.io.Serializable
,java.lang.AutoCloseable
,org.apache.wicket.util.io.IClusterable
,org.apache.wicket.util.resource.IResourceStream
,org.apache.wicket.util.resource.IStringResourceStream
,org.apache.wicket.util.watch.IModifiable
public class PackageTextTemplate extends TextTemplate
AString
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 java.lang.String
DEFAULT_CONTENT_TYPE
The content type used if not provided in the constructorstatic java.lang.String
DEFAULT_ENCODING
The encoding used if not provided in the constructor
-
Constructor Summary
Constructors Constructor Description PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName)
Constructor.PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName, java.lang.String contentType)
Constructor.PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName, java.lang.String contentType, java.lang.String encoding)
Constructor.PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName, java.lang.String style, java.lang.String variation, java.util.Locale locale, java.lang.String contentType, java.lang.String encoding)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getString()
Retrieves theString
resource.TextTemplate
interpolate(java.util.Map<java.lang.String,?> variables)
Interpolates aMap
of variables with the content and replaces the content with the result.void
setEncoding(java.lang.String encoding)
void
setLocale(java.util.Locale locale)
void
setStyle(java.lang.String style)
void
setVariation(java.lang.String variation)
-
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
-
-
-
-
Field Detail
-
DEFAULT_CONTENT_TYPE
public static final java.lang.String DEFAULT_CONTENT_TYPE
The content type used if not provided in the constructor- See Also:
- Constant Field Values
-
DEFAULT_ENCODING
public static final java.lang.String DEFAULT_ENCODING
The encoding used if not provided in the constructor
-
-
Constructor Detail
-
PackageTextTemplate
public PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName)
Constructor.- Parameters:
clazz
- theClass
to be used for retrieving the classloader for loading thePackagedTextTemplate
fileName
- the name of the file, relative to theclazz
position
-
PackageTextTemplate
public PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName, java.lang.String contentType)
Constructor.- Parameters:
clazz
- theClass
to be used for retrieving the classloader for loading thePackagedTextTemplate
fileName
- the name of the file, relative to theclazz
positioncontentType
- the mime type of this resource, such as "image/jpeg
" or "text/html
"
-
PackageTextTemplate
public PackageTextTemplate(java.lang.Class<?> clazz, java.lang.String fileName, java.lang.String contentType, java.lang.String encoding)
Constructor.- Parameters:
clazz
- theClass
to be used for retrieving the classloader for loading thePackagedTextTemplate
fileName
- the name of the file, relative to theclazz
positioncontentType
- 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(java.lang.Class<?> clazz, java.lang.String fileName, java.lang.String style, java.lang.String variation, java.util.Locale locale, java.lang.String contentType, java.lang.String encoding)
Constructor.- Parameters:
clazz
- theClass
to be used for retrieving the classloader for loading thePackagedTextTemplate
fileName
- the name of the file, relative to theclazz
positionstyle
- Any resource style, such as a skin style (seeSession
)variation
- The template's variation (of the style)locale
- The locale of the resource to loadcontentType
- the mime type of this resource, such as "image/jpeg
" or "text/html
"encoding
- the file's encoding, for example, "UTF-8
"
-
-
Method Detail
-
setStyle
public void setStyle(java.lang.String style)
- Specified by:
setStyle
in interfaceorg.apache.wicket.util.resource.IResourceStream
- Overrides:
setStyle
in classorg.apache.wicket.util.resource.AbstractResourceStream
-
setLocale
public void setLocale(java.util.Locale locale)
- Specified by:
setLocale
in interfaceorg.apache.wicket.util.resource.IResourceStream
- Overrides:
setLocale
in classorg.apache.wicket.util.resource.AbstractResourceStream
-
setVariation
public void setVariation(java.lang.String variation)
- Specified by:
setVariation
in interfaceorg.apache.wicket.util.resource.IResourceStream
- Overrides:
setVariation
in classorg.apache.wicket.util.resource.AbstractResourceStream
-
setEncoding
public void setEncoding(java.lang.String encoding)
-
getString
public java.lang.String getString()
Description copied from class:TextTemplate
Retrieves theString
resource.- Specified by:
getString
in classTextTemplate
- Returns:
- the
String
resource - See Also:
AbstractStringResourceStream.getString()
-
interpolate
public final TextTemplate interpolate(java.util.Map<java.lang.String,?> variables)
Interpolates aMap
of variables with the content and replaces the content with the result. Variables are denoted in theString
by thesyntax ${variableName}
. The contents will be altered by replacing each variable of the form${variableName}
with the value returned byvariables.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 classTextTemplate
- Parameters:
variables
- aMap
of variables to interpolate- Returns:
- this for chaining
-
-