org.apache.velocity.runtime.resource.util
Interface StringResourceRepository

All Known Implementing Classes:

StringResourceRepositoryImpl

public interface StringResourceRepository

A StringResourceRepository functions as a central repository for Velocity templates stored in Strings.

Version:

$Id: StringResourceRepository.java 479058 2006-11-25 00:26:32Z henning $

Author:

Eelco Hillenius, Henning P. Schmiedehausen

Method Summary

String	getEncoding() Returns the current encoding of this repository.
StringResource	getStringResource(String name) get the string resource that is stored with given key
void	putStringResource(String name, String body) add a string resource with given key.
void	removeStringResource(String name) delete a string resource with given key.
void	setEncoding(String encoding) Sets the encoding of the repository.

Method Detail

getStringResource

StringResource getStringResource(String name)

get the string resource that is stored with given key

Parameters:

name - String name to retrieve from the repository.

Returns:

A StringResource containing the template.

putStringResource

void putStringResource(String name,
                       String body)

add a string resource with given key.

Parameters:

name - The String name to store the template under.

body - A String containing a template.

removeStringResource

void removeStringResource(String name)

delete a string resource with given key.

Parameters:

name - The string name to remove from the repository.

setEncoding

void setEncoding(String encoding)

Sets the encoding of the repository. The encoding should be stored per template string so that multiple encodings can be stored in a single repository. The default implementation does this correctly.

Parameters:

encoding - The encoding to use.

getEncoding

String getEncoding()

Returns the current encoding of this repository.

Returns:

The current encoding of this repository.