RuntimeServices (bboss-velocity 6.1.5 API)

所有超级接口:

RuntimeLogger

所有已知实现类:

RuntimeInstance
```
public interface RuntimeServices
extends RuntimeLogger
```
Interface for internal runtime services that are needed by the various components w/in Velocity. This was taken from the old Runtime singleton, and anything not necessary was removed. Currently implemented by RuntimeInstance.

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`void`	`addProperty(java.lang.String key, java.lang.Object value)` Add a property to the configuration.
`boolean`	`addVelocimacro(java.lang.String name, Node macro, java.lang.String[] argArray, java.lang.String sourceTemplate)` Adds a new Velocimacro.
`boolean`	`addVelocimacro(java.lang.String name, java.lang.String macro, java.lang.String[] argArray, java.lang.String sourceTemplate)` 已过时。 Use addVelocimacro(String, Node, String[], String) instead
`void`	`clearProperty(java.lang.String key)` Clear the values pertaining to a particular property.
`Parser`	`createNewParser()` Create a new parser instance.
`boolean`	`dumpVMNamespace(java.lang.String namespace)` tells the vmFactory to dump the specified namespace.
`boolean`	`evaluate(Context context, java.io.Writer writer, java.lang.String logTag, java.io.Reader reader)` Renders the input reader using the context into the output writer.
`boolean`	`evaluate(Context context, java.io.Writer out, java.lang.String logTag, java.lang.String instring)` Renders the input string using the context into the output writer.
`java.lang.Object`	`getApplicationAttribute(java.lang.Object key)` Return the specified application attribute.
`EventCartridge`	`getApplicationEventCartridge()` Returns the event handlers for the application.
`boolean`	`getBoolean(java.lang.String key, boolean def)` Boolean property accessor method to hide the configuration implementation.
`org.apache.commons.collections.ExtendedProperties`	`getConfiguration()` Return the velocity runtime configuration object.
`ContentResource`	`getContent(java.lang.String name)` Returns a static content resource from the resource manager.
`ContentResource`	`getContent(java.lang.String name, java.lang.String encoding)` Returns a static content resource from the resource manager.
`Directive`	`getDirective(java.lang.String name)` Retrieve a previously instantiated directive.
`int`	`getInt(java.lang.String key)` Int property accessor method to hide the configuration implementation.
`int`	`getInt(java.lang.String key, int defaultValue)` Int property accessor method to hide the configuration implementation.
`Introspector`	`getIntrospector()` Returns the configured method introspection/reflection implementation.
`java.lang.String`	`getLoaderNameForResource(java.lang.String resourceName)` Determines is a template exists, and returns name of the loader that provides it.
`Log`	`getLog()` Returns a convenient Log instance that wraps the current LogChute.
`java.lang.Object`	`getProperty(java.lang.String key)` Allows an external caller to get a property.
`java.lang.String`	`getString(java.lang.String key)` String property accessor method to hide the configuration implementation
`java.lang.String`	`getString(java.lang.String key, java.lang.String defaultValue)` String property accessor method with default to hide the configuration implementation.
`Template`	`getTemplate(java.lang.String name)` Returns a `Template` from the resource manager.
`Template`	`getTemplate(java.lang.String name, java.lang.String encoding)` Returns a `Template` from the resource manager
`Uberspect`	`getUberspect()` Returns the configured class introspection/reflection implementation.
`Directive`	`getVelocimacro(java.lang.String vmName, java.lang.String templateName)` Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
`Directive`	`getVelocimacro(java.lang.String vmName, java.lang.String templateName, java.lang.String renderingTemplate)` Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
`void`	`init()` This is the primary initialization method in the Velocity Runtime.
`void`	`init(java.util.Properties p)` Initialize the Velocity Runtime with a Properties object.
`void`	`init(java.lang.String configurationFile)` Initialize the Velocity Runtime with the name of ExtendedProperties object.
`boolean`	`invokeVelocimacro(java.lang.String vmName, java.lang.String logTag, java.lang.String[] params, Context context, java.io.Writer writer)` Invokes a currently registered Velocimacro with the params provided and places the rendered stream into the writer.
`boolean`	`isInitialized()` Returns true if the RuntimeInstance has been successfully initialized.
`boolean`	`isVelocimacro(java.lang.String vmName, java.lang.String templateName)` Checks to see if a VM exists
`SimpleNode`	`parse(java.io.Reader reader, java.lang.String templateName)` Parse the input and return the root of AST node structure.
`SimpleNode`	`parse(java.io.Reader reader, java.lang.String templateName, boolean dumpNamespace)` Parse the input and return the root of the AST node structure.
`SimpleNode`	`parse(java.lang.String string, java.lang.String templateName)` Wraps the String in a StringReader and passes it off to `parse(Reader,String)`.
`java.lang.Object`	`setApplicationAttribute(java.lang.Object key, java.lang.Object value)` Set the specified application attribute.
`void`	`setConfiguration(org.apache.commons.collections.ExtendedProperties configuration)` Allow an external system to set an ExtendedProperties object to use.
`void`	`setProperty(java.lang.String key, java.lang.Object value)` Allows an external system to set a property in the Velocity Runtime.

从接口继承的方法 bboss.org.apache.velocity.runtime.RuntimeLogger
debug, error, info, warn

- 方法详细资料
  - init
```
void init()
```
    This is the primary initialization method in the Velocity Runtime. The systems that are setup/initialized here are as follows:
    - Logging System
    - ResourceManager
    - Parser Pool
    - Global Cache
    - Static Content Include System
    - Velocimacro System
  - setProperty
```
void setProperty(java.lang.String key,
                 java.lang.Object value)
```
    Allows an external system to set a property in the Velocity Runtime.
    
    参数:
    
    key - property key
    
    value - property value
  - setConfiguration
```
void setConfiguration(org.apache.commons.collections.ExtendedProperties configuration)
```
    Allow an external system to set an ExtendedProperties object to use. This is useful where the external system also uses the ExtendedProperties class and the velocity configuration is a subset of parent application's configuration. This is the case with Turbine.
    
    参数:
    
    configuration -
  - addProperty
```
void addProperty(java.lang.String key,
                 java.lang.Object value)
```
    Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if resource.loader = file is already present in the configuration and you addProperty("resource.loader", "classpath") Then you will end up with a Vector like the following: ["file", "classpath"]
    
    参数:
    
    key -
    
    value -
  - clearProperty
```
void clearProperty(java.lang.String key)
```
    Clear the values pertaining to a particular property.
    
    参数:
    
    key - of property to clear
  - getProperty
```
java.lang.Object getProperty(java.lang.String key)
```
    Allows an external caller to get a property. The calling routine is required to know the type, as this routine will return an Object, as that is what properties can be.
    
    参数:
    
    key - property to return
    
    返回:
    
    The value.
  - init
```
void init(java.util.Properties p)
```
    Initialize the Velocity Runtime with a Properties object.
    
    参数:
    
    p -
  - init
```
void init(java.lang.String configurationFile)
```
    Initialize the Velocity Runtime with the name of ExtendedProperties object.
    
    参数:
    
    configurationFile -
  - parse
```
SimpleNode parse(java.lang.String string,
                 java.lang.String templateName)
          throws ParseException
```
    Wraps the String in a StringReader and passes it off to parse(Reader,String).
    
    抛出:
    
    ParseException
    
    从以下版本开始:
    
    1.6
  - parse
```
SimpleNode parse(java.io.Reader reader,
                 java.lang.String templateName)
          throws ParseException
```
    Parse the input and return the root of AST node structure.
    
    In the event that it runs out of parsers in the pool, it will create and let them be GC'd dynamically, logging that it has to do that. This is considered an exceptional condition. It is expected that the user will set the PARSER_POOL_SIZE property appropriately for their application. We will revisit this.
    
    参数:
    
    reader - inputstream retrieved by a resource loader
    
    templateName - name of the template being parsed
    
    返回:
    
    The AST representing the template.
    
    抛出:
    
    ParseException
  - parse
```
SimpleNode parse(java.io.Reader reader,
                 java.lang.String templateName,
                 boolean dumpNamespace)
          throws ParseException
```
    Parse the input and return the root of the AST node structure.
    
    参数:
    
    reader - inputstream retrieved by a resource loader
    
    templateName - name of the template being parsed
    
    dumpNamespace - flag to dump the Velocimacro namespace for this template
    
    返回:
    
    The AST representing the template.
    
    抛出:
    
    ParseException
  - evaluate
```
boolean evaluate(Context context,
                 java.io.Writer out,
                 java.lang.String logTag,
                 java.lang.String instring)
```
    Renders the input string using the context into the output writer. To be used when a template is dynamically constructed, or want to use Velocity as a token replacer.
    
    参数:
    
    context - context to use in rendering input string
    
    out - Writer in which to render the output
    
    logTag - string to be used as the template name for log messages in case of error
    
    instring - input string containing the VTL to be rendered
    
    返回:
    
    true if successful, false otherwise. If false, see Velocity runtime log
    
    抛出:
    
    ParseErrorException - The template could not be parsed.
    
    MethodInvocationException - A method on a context object could not be invoked.
    
    ResourceNotFoundException - A referenced resource could not be loaded.
    
    从以下版本开始:
    
    Velocity 1.6
  - evaluate
```
boolean evaluate(Context context,
                 java.io.Writer writer,
                 java.lang.String logTag,
                 java.io.Reader reader)
```
    Renders the input reader using the context into the output writer. To be used when a template is dynamically constructed, or want to use Velocity as a token replacer.
    
    参数:
    
    context - context to use in rendering input string
    
    writer - Writer in which to render the output
    
    logTag - string to be used as the template name for log messages in case of error
    
    reader - Reader containing the VTL to be rendered
    
    返回:
    
    true if successful, false otherwise. If false, see Velocity runtime log
    
    抛出:
    
    ParseErrorException - The template could not be parsed.
    
    MethodInvocationException - A method on a context object could not be invoked.
    
    ResourceNotFoundException - A referenced resource could not be loaded.
    
    从以下版本开始:
    
    Velocity 1.6
  - invokeVelocimacro
```
boolean invokeVelocimacro(java.lang.String vmName,
                          java.lang.String logTag,
                          java.lang.String[] params,
                          Context context,
                          java.io.Writer writer)
```
    Invokes a currently registered Velocimacro with the params provided and places the rendered stream into the writer.
    Note : currently only accepts args to the VM if they are in the context.
    
    参数:
    
    vmName - name of Velocimacro to call
    
    logTag - string to be used for template name in case of error. if null, the vmName will be used
    
    params - keys for args used to invoke Velocimacro, in java format rather than VTL (eg "foo" or "bar" rather than "$foo" or "$bar")
    
    context - Context object containing data/objects used for rendering.
    
    writer - Writer for output stream
    
    返回:
    
    true if Velocimacro exists and successfully invoked, false otherwise.
    
    从以下版本开始:
    
    1.6
  - getTemplate
```
Template getTemplate(java.lang.String name)
              throws ResourceNotFoundException,
                     ParseErrorException
```
    Returns a Template from the resource manager. This method assumes that the character encoding of the template is set by the input.encoding property. The default is "ISO-8859-1"
    
    参数:
    
    name - The file name of the desired template.
    
    返回:
    
    The template.
    
    抛出:
    
    ResourceNotFoundException - if template not found from any available source.
    
    ParseErrorException - if template cannot be parsed due to syntax (or other) error.
  - getTemplate
```
Template getTemplate(java.lang.String name,
                     java.lang.String encoding)
              throws ResourceNotFoundException,
                     ParseErrorException
```
    Returns a Template from the resource manager
    
    参数:
    
    name - The name of the desired template.
    
    encoding - Character encoding of the template
    
    返回:
    
    The template.
    
    抛出:
    
    ResourceNotFoundException - if template not found from any available source.
    
    ParseErrorException - if template cannot be parsed due to syntax (or other) error.
  - getContent
```
ContentResource getContent(java.lang.String name)
                    throws ResourceNotFoundException,
                           ParseErrorException
```
    Returns a static content resource from the resource manager. Uses the current value if INPUT_ENCODING as the character encoding.
    
    参数:
    
    name - Name of content resource to get
    
    返回:
    
    parsed ContentResource object ready for use
    
    抛出:
    
    ResourceNotFoundException - if template not found from any available source.
    
    ParseErrorException
  - getContent
```
ContentResource getContent(java.lang.String name,
                           java.lang.String encoding)
                    throws ResourceNotFoundException,
                           ParseErrorException
```
    Returns a static content resource from the resource manager.
    
    参数:
    
    name - Name of content resource to get
    
    encoding - Character encoding to use
    
    返回:
    
    parsed ContentResource object ready for use
    
    抛出:
    
    ResourceNotFoundException - if template not found from any available source.
    
    ParseErrorException
  - getLoaderNameForResource
```
java.lang.String getLoaderNameForResource(java.lang.String resourceName)
```
    Determines is a template exists, and returns name of the loader that provides it. This is a slightly less hokey way to support the Velocity.templateExists() utility method, which was broken when per-template encoding was introduced. We can revisit this.
    
    参数:
    
    resourceName - Name of template or content resource
    
    返回:
    
    class name of loader than can provide it
  - getString
```
java.lang.String getString(java.lang.String key,
                           java.lang.String defaultValue)
```
    String property accessor method with default to hide the configuration implementation.
    
    参数:
    
    key - property key
    
    defaultValue - default value to return if key not found in resource manager.
    
    返回:
    
    String value of key or default
  - getVelocimacro
```
Directive getVelocimacro(java.lang.String vmName,
                         java.lang.String templateName)
```
    Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
    
    参数:
    
    vmName - Name of velocimacro requested
    
    templateName - Name of the namespace.
    
    返回:
    
    VelocimacroProxy
  - getVelocimacro
```
Directive getVelocimacro(java.lang.String vmName,
                         java.lang.String templateName,
                         java.lang.String renderingTemplate)
```
    Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
    
    参数:
    
    vmName - Name of velocimacro requested
    
    templateName - Name of the namespace.
    
    renderingTemplate - Name of the template we are currently rendering. This information is needed when VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL setting is true and template contains a macro with the same name as the global macro library.
    
    返回:
    
    VelocimacroProxy
    
    从以下版本开始:
    
    Velocity 1.6
  - addVelocimacro
```
boolean addVelocimacro(java.lang.String name,
                       java.lang.String macro,
                       java.lang.String[] argArray,
                       java.lang.String sourceTemplate)
```
    已过时。 Use addVelocimacro(String, Node, String[], String) instead
    
    Adds a new Velocimacro. Usually called by Macro only while parsing.
    
    参数:
    
    name - Name of velocimacro
    
    macro - String form of macro body
    
    argArray - Array of strings, containing the #macro() arguments. the 0th is the name.
    
    sourceTemplate -
    
    返回:
    
    boolean True if added, false if rejected for some reason (either parameters or permission settings)
  - addVelocimacro
```
boolean addVelocimacro(java.lang.String name,
                       Node macro,
                       java.lang.String[] argArray,
                       java.lang.String sourceTemplate)
```
    Adds a new Velocimacro. Usually called by Macro only while parsing.
    
    参数:
    
    name - Name of velocimacro
    
    macro - root AST node of the parsed macro
    
    argArray - Array of strings, containing the #macro() arguments. the 0th is the name.
    
    sourceTemplate -
    
    返回:
    
    boolean True if added, false if rejected for some reason (either parameters or permission settings)
    
    从以下版本开始:
    
    Velocity 1.6
  - isVelocimacro
```
boolean isVelocimacro(java.lang.String vmName,
                      java.lang.String templateName)
```
    Checks to see if a VM exists
    
    参数:
    
    vmName - Name of velocimacro
    
    templateName -
    
    返回:
    
    boolean True if VM by that name exists, false if not
  - dumpVMNamespace
```
boolean dumpVMNamespace(java.lang.String namespace)
```
    tells the vmFactory to dump the specified namespace. This is to support clearing the VM list when in inline-VM-local-scope mode
    
    参数:
    
    namespace -
    
    返回:
    
    True if the Namespace was dumped.
  - getString
```
java.lang.String getString(java.lang.String key)
```
    String property accessor method to hide the configuration implementation
    
    参数:
    
    key - property key
    
    返回:
    
    value of key or null
  - getInt
```
int getInt(java.lang.String key)
```
    Int property accessor method to hide the configuration implementation.
    
    参数:
    
    key - property key
    
    返回:
    
    int value
  - getInt
```
int getInt(java.lang.String key,
           int defaultValue)
```
    Int property accessor method to hide the configuration implementation.
    
    参数:
    
    key - property key
    
    defaultValue - default value
    
    返回:
    
    int value
  - getBoolean
```
boolean getBoolean(java.lang.String key,
                   boolean def)
```
    Boolean property accessor method to hide the configuration implementation.
    
    参数:
    
    key - property key
    
    def - default default value if property not found
    
    返回:
    
    boolean value of key or default value
  - getConfiguration
```
org.apache.commons.collections.ExtendedProperties getConfiguration()
```
    Return the velocity runtime configuration object.
    
    返回:
    
    ExtendedProperties configuration object which houses the velocity runtime properties.
  - getApplicationAttribute
```
java.lang.Object getApplicationAttribute(java.lang.Object key)
```
    Return the specified application attribute.
    
    参数:
    
    key - The name of the attribute to retrieve.
    
    返回:
    
    The value of the attribute.
  - setApplicationAttribute
```
java.lang.Object setApplicationAttribute(java.lang.Object key,
                                         java.lang.Object value)
```
    Set the specified application attribute.
    
    参数:
    
    key - The name of the attribute to set.
    
    value - The attribute value to set.
    
    返回:
    
    the displaced attribute value
  - getUberspect
```
Uberspect getUberspect()
```
    Returns the configured class introspection/reflection implementation.
    
    返回:
    
    The current Uberspect object.
  - getLog
```
Log getLog()
```
    Returns a convenient Log instance that wraps the current LogChute.
    
    返回:
    
    A log object.
  - getApplicationEventCartridge
```
EventCartridge getApplicationEventCartridge()
```
    Returns the event handlers for the application.
    
    返回:
    
    The event handlers for the application.
  - getIntrospector
```
Introspector getIntrospector()
```
    Returns the configured method introspection/reflection implementation.
    
    返回:
    
    The configured method introspection/reflection implementation.
  - isInitialized
```
boolean isInitialized()
```
    Returns true if the RuntimeInstance has been successfully initialized.
    
    返回:
    
    True if the RuntimeInstance has been successfully initialized.
  - createNewParser
```
Parser createNewParser()
```
    Create a new parser instance.
    
    返回:
    
    A new parser instance.
  - getDirective
```
Directive getDirective(java.lang.String name)
```
    Retrieve a previously instantiated directive.
    
    参数:
    
    name - name of the directive
    
    返回:
    
    the directive with that name, if any
    
    从以下版本开始:
    
    1.6

接口 RuntimeServices

方法概要

从接口继承的方法 bboss.org.apache.velocity.runtime.RuntimeLogger

方法详细资料

init

setProperty

setConfiguration

addProperty

clearProperty

getProperty

init

init

parse

parse

parse

evaluate

evaluate

invokeVelocimacro

getTemplate

getTemplate

getContent

getContent

getLoaderNameForResource

getString

getVelocimacro

getVelocimacro

addVelocimacro

addVelocimacro

isVelocimacro

dumpVMNamespace

getString

getInt

getInt

getBoolean

getConfiguration

getApplicationAttribute

setApplicationAttribute

getUberspect

getLog

getApplicationEventCartridge

getIntrospector

isInitialized

createNewParser

getDirective