StringResourceLoader (bboss-velocity 6.1.5 API)

java.lang.Object
- bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader
- - bboss.org.apache.velocity.runtime.resource.loader.StringResourceLoader

```
public class StringResourceLoader
extends ResourceLoader
```
Resource loader that works with Strings. Users should manually add resources to the repository that is used by the resource loader instance. Below is an example configuration for this loader. Note that 'repository.class' is not necessary; if not provided, the factory will fall back on using StringResourceRepositoryImpl as the default.
```
 resource.loader = string
 string.resource.loader.description = Velocity StringResource loader
 string.resource.loader.class = bboss.org.apache.velocity.runtime.resource.loader.StringResourceLoader
 string.resource.loader.repository.class = bboss.org.apache.velocity.runtime.resource.util.StringResourceRepositoryImpl
 
```
Resources 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 'bboss.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.
从以下版本开始:

1.5

字段概要

字段
限定符和类型	字段和说明
`protected StringResourceRepository`	`repository`
`static java.lang.String`	`REPOSITORY_CLASS` Key to look up the repository implementation class.
`static java.lang.String`	`REPOSITORY_CLASS_DEFAULT` The default implementation class.
`static java.lang.String`	`REPOSITORY_ENCODING` Key to look up the repository char encoding.
`static java.lang.String`	`REPOSITORY_ENCODING_DEFAULT` The default repository encoding.
`static java.lang.String`	`REPOSITORY_NAME` Key to look up the name for the repository to be used.
`static java.lang.String`	`REPOSITORY_NAME_DEFAULT` The default name for string resource repositories ('bboss.org.apache.velocity.runtime.resource.util.StringResourceRepository').
`static java.lang.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 java.util.Map`	`STATIC_REPOSITORIES`

从类继承的字段 bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader
className, isCachingOn, log, modificationCheckInterval, rsvc

构造器概要

构造器
构造器和说明

StringResourceLoader()

构造器
构造器和说明
`StringResourceLoader()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static void`	`clearRepositories()` Removes all statically stored `StringResourceRepository`s.
`StringResourceRepository`	`createRepository(java.lang.String className, java.lang.String encoding)`
`long`	`getLastModified(Resource resource)` Get the last modified time of the InputStream source that was used to create the template.
`static StringResourceRepository`	`getRepository()` Returns a reference to the default static repository.
`static StringResourceRepository`	`getRepository(java.lang.String name)` Returns a reference to the repository stored statically under the specified name.
`java.io.InputStream`	`getResourceStream(java.lang.String name)` Get an InputStream so that the Runtime can build a template with it.
`void`	`init(org.apache.commons.collections.ExtendedProperties configuration)` Initialize the template loader with a a resources class.
`boolean`	`isSourceModified(Resource resource)` Given a template, check to see if the source of InputStream has been modified.
`static StringResourceRepository`	`removeRepository(java.lang.String name)` Removes the `StringResourceRepository` stored under the specified name.
`boolean`	`resourceExists(java.lang.String name)` Overrides superclass for better performance.
`static void`	`setRepository(java.lang.String name, StringResourceRepository repo)` Sets the specified `StringResourceRepository` in static storage under the specified name.

从类继承的方法 bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader
commonInit, getClassName, getModificationCheckInterval, isCachingOn, setCachingOn, setModificationCheckInterval

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - REPOSITORY_STATIC
```
public static final java.lang.String REPOSITORY_STATIC
```
    Key to determine whether the repository should be set as the static one or not.
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    常量字段值
  - REPOSITORY_STATIC_DEFAULT
```
public static final boolean REPOSITORY_STATIC_DEFAULT
```
    By default, repositories are stored statically (shared across the VM).
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    常量字段值
  - REPOSITORY_CLASS
```
public static final java.lang.String REPOSITORY_CLASS
```
    Key to look up the repository implementation class.
    
    另请参阅:
    
    常量字段值
  - REPOSITORY_CLASS_DEFAULT
```
public static final java.lang.String REPOSITORY_CLASS_DEFAULT
```
    The default implementation class.
  - REPOSITORY_NAME
```
public static final java.lang.String REPOSITORY_NAME
```
    Key to look up the name for the repository to be used.
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    常量字段值
  - REPOSITORY_NAME_DEFAULT
```
public static final java.lang.String REPOSITORY_NAME_DEFAULT
```
    The default name for string resource repositories ('bboss.org.apache.velocity.runtime.resource.util.StringResourceRepository').
    
    从以下版本开始:
    
    1.6
  - REPOSITORY_ENCODING
```
public static final java.lang.String REPOSITORY_ENCODING
```
    Key to look up the repository char encoding.
    
    另请参阅:
    
    常量字段值
  - REPOSITORY_ENCODING_DEFAULT
```
public static final java.lang.String REPOSITORY_ENCODING_DEFAULT
```
    The default repository encoding.
    
    另请参阅:
    
    常量字段值
  - STATIC_REPOSITORIES
```
protected static final java.util.Map STATIC_REPOSITORIES
```
  - repository
```
protected StringResourceRepository repository
```
- 构造器详细资料
  - StringResourceLoader
```
public StringResourceLoader()
```
- 方法详细资料
  - getRepository
```
public static StringResourceRepository getRepository()
```
    Returns a reference to the default static repository.
  - getRepository
```
public static StringResourceRepository getRepository(java.lang.String name)
```
    Returns a reference to the repository stored statically under the specified name.
    
    从以下版本开始:
    
    1.6
  - setRepository
```
public static void setRepository(java.lang.String name,
                                 StringResourceRepository repo)
```
    Sets the specified StringResourceRepository in static storage under the specified name.
    
    从以下版本开始:
    
    1.6
  - removeRepository
```
public static StringResourceRepository removeRepository(java.lang.String name)
```
    Removes the StringResourceRepository stored under the specified name.
    
    从以下版本开始:
    
    1.6
  - clearRepositories
```
public static void clearRepositories()
```
    Removes all statically stored StringResourceRepositorys.
    
    从以下版本开始:
    
    1.6
  - init
```
public void init(org.apache.commons.collections.ExtendedProperties configuration)
```
    从类复制的说明: ResourceLoader
    
    Initialize the template loader with a a resources class.
    
    指定者:
    
    init 在类中 ResourceLoader
    
    另请参阅:
    
    ResourceLoader.init(org.apache.commons.collections.ExtendedProperties)
  - createRepository
```
public StringResourceRepository createRepository(java.lang.String className,
                                                 java.lang.String encoding)
```
    从以下版本开始:
    
    1.6
  - resourceExists
```
public boolean resourceExists(java.lang.String name)
```
    Overrides superclass for better performance.
    
    覆盖:
    
    resourceExists 在类中 ResourceLoader
    
    参数:
    
    name - The name of a resource.
    
    返回:
    
    true if a resource exists and can be accessed.
    
    从以下版本开始:
    
    1.6
  - getResourceStream
```
public java.io.InputStream getResourceStream(java.lang.String name)
                                      throws ResourceNotFoundException
```
    Get an InputStream so that the Runtime can build a template with it.
    
    指定者:
    
    getResourceStream 在类中 ResourceLoader
    
    参数:
    
    name - name of template to get.
    
    返回:
    
    InputStream containing the template.
    
    抛出:
    
    ResourceNotFoundException - Ff template not found in the RepositoryFactory.
  - isSourceModified
```
public boolean isSourceModified(Resource resource)
```
    从类复制的说明: ResourceLoader
    
    Given a template, check to see if the source of InputStream has been modified.
    
    指定者:
    
    isSourceModified 在类中 ResourceLoader
    
    返回:
    
    True if the resource has been modified.
    
    另请参阅:
    
    ResourceLoader.isSourceModified(bboss.org.apache.velocity.runtime.resource.Resource)
  - getLastModified
```
public long getLastModified(Resource resource)
```
    从类复制的说明: ResourceLoader
    
    Get the last modified time of the InputStream source that was used to create the template. We need the template here because we have to extract the name of the template in order to locate the InputStream source.
    
    指定者:
    
    getLastModified 在类中 ResourceLoader
    
    返回:
    
    Time in millis when the resource has been modified.
    
    另请参阅:
    
    ResourceLoader.getLastModified(bboss.org.apache.velocity.runtime.resource.Resource)

类 StringResourceLoader

字段概要

从类继承的字段 bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader

构造器概要

方法概要

从类继承的方法 bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader

从类继承的方法 java.lang.Object

字段详细资料

REPOSITORY_STATIC

REPOSITORY_STATIC_DEFAULT

REPOSITORY_CLASS

REPOSITORY_CLASS_DEFAULT

REPOSITORY_NAME

REPOSITORY_NAME_DEFAULT

REPOSITORY_ENCODING

REPOSITORY_ENCODING_DEFAULT

STATIC_REPOSITORIES

repository

构造器详细资料

StringResourceLoader

方法详细资料

getRepository

getRepository

setRepository

removeRepository

clearRepositories

init

createRepository

resourceExists

getResourceStream

isSourceModified

getLastModified