org.apache.wicket.util.template
Class PackagedTextTemplate

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.PackagedTextTemplate

All Implemented Interfaces:

java.io.Serializable, IClusterable, IResourceStream, IStringResourceStream, IModifiable

public class PackagedTextTemplate
extends TextTemplate

A String resource that can be appended to.

Since:

1.2.6

Author:

Eelco Hillenius

See Also:

Serialized Form

Constructor Summary

PackagedTextTemplate(java.lang.Class clazz, java.lang.String fileName)
Constructor.

PackagedTextTemplate(java.lang.Class clazz, java.lang.String fileName, java.lang.String contentType)
Constructor.

PackagedTextTemplate(java.lang.Class clazz, java.lang.String fileName, java.lang.String contentType, java.lang.String encoding)
Constructor.

Method Summary

java.lang.String	getString() Retrieves the String resource.
TextTemplate	interpolate(java.util.Map variables) Interpolates a Map of variables with the content and replaces the content with the result.
long	length() Gets the size of this resource in bytes TODO 1.5: rename to lengthInBytes() or let it return some sort of size object

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

asString, asString

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

close, getContentType, getInputStream, lastModifiedTime, setLastModified

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

getCharset, getLocale, setCharset, setLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

PackagedTextTemplate

public PackagedTextTemplate(java.lang.Class clazz,
                            java.lang.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

PackagedTextTemplate

public PackagedTextTemplate(java.lang.Class clazz,
                            java.lang.String fileName,
                            java.lang.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"

PackagedTextTemplate

public PackagedTextTemplate(java.lang.Class clazz,
                            java.lang.String fileName,
                            java.lang.String contentType,
                            java.lang.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"

Method Detail

getString

public java.lang.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(java.util.Map 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

length

public final long length()

Description copied from interface: IResourceStream

Gets the size of this resource in bytes TODO 1.5: rename to lengthInBytes() or let it return some sort of size object

Specified by:

length in interface IResourceStream

Overrides:

length in class AbstractResourceStream

Returns:

The size of this resource in the number of bytes, or -1 if unknown

See Also:

IResourceStream.length()