public class StringResourceLoader
extends org.apache.velocity.runtime.resource.loader.ResourceLoader
StringResourceRepositoryImpl
as the default.
resource.loader = string string.resource.loader.description = Velocity StringResource loader string.resource.loader.class = org.apache.velocity.runtime.resource.loader.StringResourceLoader string.resource.loader.repository.class = org.apache.velocity.runtime.resource.loader.StringResourceRepositoryImplResources can be added to the repository like this:
StringResourceRepository repo = StringResourceLoader.getRepository();
String myTemplateName = "/some/imaginary/path/hello.vm";
String myTemplate = "Hi, ${username}... this is some template!";
repo.putStringResource(myTemplateName, myTemplate);
After this, the templates can be retrieved as usual. If there will be multiple StringResourceLoaders used in an application, you should consider specifying a 'string.resource.loader.repository.name = foo' property in order to keep you string resources in a non-default repository. This can help to avoid conflicts between different frameworks or components that are using StringResourceLoader. You can then retrieve your named repository like this:
StringResourceRepository repo = StringResourceLoader.getRepository("foo");
and add string resources to the repo just as in the previous example.
If you have concerns about memory leaks or for whatever reason do not wish to have your string repository stored statically as a class member, then you should set 'string.resource.loader.repository.static = false' in your properties. This will tell the resource loader that the string repository should be stored in the Velocity application attributes. To retrieve the repository, do:
StringResourceRepository repo = velocityEngine.getApplicationAttribute("foo");
If you did not specify a name for the repository, then it will be stored under the class name of the repository
implementation class (for which the default is
'org.apache.velocity.runtime.resource.util.StringResourceRepositoryImpl'). Incidentally, this is also true for the
default statically stored repository.
Whether your repository is stored statically or in Velocity's application attributes, you can also manually create and set it prior to Velocity initialization. For a static repository, you can do something like this:
StringResourceRepository repo = new MyStringResourceRepository();
repo.magicallyAddSomeStringResources();
StringResourceLoader.setRepository("foo", repo);
Or for a non-static repository:
StringResourceRepository repo = new MyStringResourceRepository();
repo.magicallyAddSomeStringResources();
velocityEngine.setApplicationAttribute("foo", repo);
Then, assuming the 'string.resource.loader.repository.name' property is set to 'some.name', the StringResourceLoader
will use that already created repository, rather than creating a new one.
Modifier and Type | Field and Description |
---|---|
static String |
REPOSITORY_CLASS
Key to look up the repository implementation class.
|
static String |
REPOSITORY_CLASS_DEFAULT
The default implementation class.
|
static String |
REPOSITORY_ENCODING
Key to look up the repository char encoding.
|
static String |
REPOSITORY_ENCODING_DEFAULT
The default repository encoding.
|
static String |
REPOSITORY_NAME
Key to look up the name for the repository to be used.
|
static String |
REPOSITORY_NAME_DEFAULT
The default name for string resource repositories
('org.apache.velocity.runtime.resource.util.StringResourceRepository').
|
static String |
REPOSITORY_STATIC
Key to determine whether the repository should be set as the static one or not.
|
static boolean |
REPOSITORY_STATIC_DEFAULT
By default, repositories are stored statically (shared across the VM).
|
protected static Map<String,org.apache.velocity.runtime.resource.util.StringResourceRepository> |
STATIC_REPOSITORIES
Local copy of static repositories.
|
Constructor and Description |
---|
StringResourceLoader() |
Modifier and Type | Method and Description |
---|---|
static void |
clearRepositories()
Removes all statically stored
StringResourceRepository s. |
org.apache.velocity.runtime.resource.util.StringResourceRepository |
createRepository(String className,
String encoding)
Create a repository.
|
long |
getLastModified(org.apache.velocity.runtime.resource.Resource resource) |
static org.apache.velocity.runtime.resource.util.StringResourceRepository |
getRepository()
Returns a reference to the default static repository.
|
static org.apache.velocity.runtime.resource.util.StringResourceRepository |
getRepository(String name)
Returns a reference to the repository stored statically under the specified name.
|
InputStream |
getResourceStream(String name)
Get an InputStream so that the Runtime can build a template with it.
|
void |
init(org.apache.commons.collections.ExtendedProperties configuration) |
boolean |
isSourceModified(org.apache.velocity.runtime.resource.Resource resource) |
static org.apache.velocity.runtime.resource.util.StringResourceRepository |
removeRepository(String name)
Removes the
StringResourceRepository stored under the specified name. |
static void |
setRepository(String name,
org.apache.velocity.runtime.resource.util.StringResourceRepository repo)
Sets the specified
StringResourceRepository in static storage under the specified name. |
public static final String REPOSITORY_STATIC
public static final boolean REPOSITORY_STATIC_DEFAULT
public static final String REPOSITORY_CLASS
public static final String REPOSITORY_CLASS_DEFAULT
public static final String REPOSITORY_NAME
public static final String REPOSITORY_NAME_DEFAULT
public static final String REPOSITORY_ENCODING
public static final String REPOSITORY_ENCODING_DEFAULT
public static org.apache.velocity.runtime.resource.util.StringResourceRepository getRepository()
public static org.apache.velocity.runtime.resource.util.StringResourceRepository getRepository(String name)
name
- name of repositorypublic static void setRepository(String name, org.apache.velocity.runtime.resource.util.StringResourceRepository repo)
StringResourceRepository
in static storage under the specified name.name
- name of repositoryrepo
- repository to addpublic static org.apache.velocity.runtime.resource.util.StringResourceRepository removeRepository(String name)
StringResourceRepository
stored under the specified name.name
- name of repositorypublic static void clearRepositories()
StringResourceRepository
s.public void init(org.apache.commons.collections.ExtendedProperties configuration)
init
in class org.apache.velocity.runtime.resource.loader.ResourceLoader
public org.apache.velocity.runtime.resource.util.StringResourceRepository createRepository(String className, String encoding)
className
- class of repository to createencoding
- encoding for repositorypublic InputStream getResourceStream(String name) throws org.apache.velocity.exception.ResourceNotFoundException
getResourceStream
in class org.apache.velocity.runtime.resource.loader.ResourceLoader
name
- name of template to get.org.apache.velocity.exception.ResourceNotFoundException
- Ff template not found in the RepositoryFactory.public boolean isSourceModified(org.apache.velocity.runtime.resource.Resource resource)
isSourceModified
in class org.apache.velocity.runtime.resource.loader.ResourceLoader
public long getLastModified(org.apache.velocity.runtime.resource.Resource resource)
getLastModified
in class org.apache.velocity.runtime.resource.loader.ResourceLoader
Copyright © 1999–2014. All rights reserved.