RuntimeInstance (bboss-velocity 6.1.5 API)

java.lang.Object
- bboss.org.apache.velocity.runtime.RuntimeInstance

所有已实现的接口:: RuntimeConstants, RuntimeLogger, RuntimeServices

public class RuntimeInstance
extends java.lang.Object
implements RuntimeConstants, RuntimeServices

This is the Runtime system for Velocity. It is the single access point for all functionality in Velocity. It adheres to the mediator pattern and is the only structure that developers need to be familiar with in order to get Velocity to perform. The Runtime will also cooperate with external systems like Turbine. Runtime properties can set and then the Runtime is initialized. Turbine, for example, knows where the templates are to be loaded from, and where the Velocity log file should be placed. So in the case of Velocity cooperating with Turbine the code might look something like the following:

 ri.setProperty(Runtime.FILE_RESOURCE_LOADER_PATH, templatePath);
 ri.setProperty(Runtime.RUNTIME_LOG, pathToVelocityLog);
 ri.init();

 -----------------------------------------------------------------------
 N O T E S  O N  R U N T I M E  I N I T I A L I Z A T I O N
 -----------------------------------------------------------------------
 init()

 If init() is called by itself the RuntimeInstance will initialize
 with a set of default values.
 -----------------------------------------------------------------------
 init(String/Properties)

 In this case the default velocity properties are layed down
 first to provide a solid base, then any properties provided
 in the given properties object will override the corresponding
 default property.
 -----------------------------------------------------------------------

字段概要
- 从接口继承的字段 bboss.org.apache.velocity.runtime.RuntimeConstants
  COUNTER_INITIAL_VALUE, COUNTER_NAME, DEBUG_PREFIX, DEFAULT_RUNTIME_DIRECTIVES, DEFAULT_RUNTIME_PROPERTIES, DEFINE_DIRECTIVE_MAXDEPTH, DIRECTIVE_IF_TOSTRING_NULLCHECK, ENCODING_DEFAULT, ERROR_PREFIX, ERRORMSG_END, ERRORMSG_START, EVALUATE_CONTEXT_CLASS, EVENTHANDLER_INCLUDE, EVENTHANDLER_INVALIDREFERENCES, EVENTHANDLER_METHODEXCEPTION, EVENTHANDLER_NULLSET, EVENTHANDLER_REFERENCEINSERTION, FILE_RESOURCE_LOADER_CACHE, FILE_RESOURCE_LOADER_PATH, HAS_NEXT_NAME, INFO_PREFIX, INPUT_ENCODING, INTERPOLATE_STRINGLITERALS, INTROSPECTOR_RESTRICT_CLASSES, INTROSPECTOR_RESTRICT_PACKAGES, MAX_NUMBER_LOOPS, NUMBER_OF_PARSERS, OUTPUT_ENCODING, PARSE_DIRECTIVE_MAXDEPTH, PARSER_POOL_CLASS, PARSER_POOL_SIZE, PROVIDE_SCOPE_CONTROL, RESOURCE_LOADER, RESOURCE_MANAGER_CACHE_CLASS, RESOURCE_MANAGER_CLASS, RESOURCE_MANAGER_DEFAULTCACHE_SIZE, RESOURCE_MANAGER_LOGWHENFOUND, RUNTIME_LOG, RUNTIME_LOG_ERROR_STACKTRACE, RUNTIME_LOG_INFO_STACKTRACE, RUNTIME_LOG_LOGSYSTEM, RUNTIME_LOG_LOGSYSTEM_CLASS, RUNTIME_LOG_REFERENCE_LOG_INVALID, RUNTIME_LOG_WARN_STACKTRACE, RUNTIME_REFERENCES_STRICT, RUNTIME_REFERENCES_STRICT_ESCAPE, SET_NULL_ALLOWED, SKIP_INVALID_ITERATOR, STRICT_MATH, TRACE_PREFIX, UBERSPECT_CLASSNAME, UNKNOWN_PREFIX, VM_ARGUMENTS_STRICT, VM_BODY_REFERENCE, VM_CONTEXT_LOCALSCOPE, VM_LIBRARY, VM_LIBRARY_AUTORELOAD, VM_LIBRARY_DEFAULT, VM_MAX_DEPTH, VM_MESSAGES_ON, VM_PERM_ALLOW_INLINE, VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL, VM_PERM_INLINE_LOCAL, WARN_PREFIX

构造器概要

构造器
构造器和说明

RuntimeInstance()
Creates a new RuntimeInstance object.

构造器
构造器和说明
`RuntimeInstance()` Creates a new RuntimeInstance object.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addDirective(Directive directive)` Programatically add a directive.
`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()` Returns a JavaCC generated Parser.
`void`	`debug(java.lang.Object message)` 已过时。 Use getLog() and call debug() on it.
`boolean`	`dumpVMNamespace(java.lang.String namespace)` tells the vmFactory to dump the specified namespace.
`void`	`error(java.lang.Object message)` 已过时。 Use getLog() and call error() on it.
`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)` Gets the application attribute for the given key
`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()` Return the Introspector for this instance
`java.lang.String`	`getLoaderNameForResource(java.lang.String resourceName)` Determines if 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 Uberspect object for this Instance.
`Directive`	`getVelocimacro(java.lang.String vmName, java.lang.String templateName)` Returns the appropriate VelocimacroProxy object if vmName 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 vmName is a valid current Velocimacro.
`void`	`info(java.lang.Object message)` 已过时。 Use getLog() and call info() on it.
`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.
`void`	`initTemplate(Resource template)`
`void`	`initTemplate(Resource template, java.lang.String encoding)` Returns a `Template` from the resource manager
`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
`void`	`loadDirective(java.lang.String directiveClass)` instantiates and loads the directive with some basic checks
`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)` Parse the input and return the root of AST node structure.
`void`	`removeDirective(java.lang.String name)` Remove a directive.
`boolean`	`render(Context context, java.io.Writer writer, java.lang.String logTag, SimpleNode nodeTree)` Initializes and renders the AST `SimpleNode` using the context into the output writer.
`java.lang.Object`	`setApplicationAttribute(java.lang.Object key, java.lang.Object o)` Sets the application attribute for the given key
`void`	`setConfiguration(org.apache.commons.collections.ExtendedProperties configuration)` Allow an external system to set an ExtendedProperties object to use.
`void`	`setProperties(java.util.Properties props)` Add all the properties in props to the RuntimeInstance properties
`void`	`setProperties(java.lang.String fileName)` Add all properties contained in the file fileName to the RuntimeInstance properties
`void`	`setProperty(java.lang.String key, java.lang.Object value)` Allows an external system to set a property in the Velocity Runtime.
`void`	`warn(java.lang.Object message)` 已过时。 Use getLog() and call warn() on it.

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

- 构造器详细资料
  - RuntimeInstance
```
public RuntimeInstance()
```
    Creates a new RuntimeInstance object.
- 方法详细资料
  - init
```
public 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
    - EventHandler
    - Parser Pool
    - Global Cache
    - Static Content Include System
    - Velocimacro System
    指定者:
    
    init 在接口中 RuntimeServices
  - isInitialized
```
public boolean isInitialized()
```
    Returns true if the RuntimeInstance has been successfully initialized.
    
    指定者:
    
    isInitialized 在接口中 RuntimeServices
    
    返回:
    
    True if the RuntimeInstance has been successfully initialized.
    
    从以下版本开始:
    
    1.5
  - setProperty
```
public void setProperty(java.lang.String key,
                        java.lang.Object value)
```
    Allows an external system to set a property in the Velocity Runtime.
    
    指定者:
    
    setProperty 在接口中 RuntimeServices
    
    参数:
    
    key - property key
    
    value - property value
  - setProperties
```
public void setProperties(java.lang.String fileName)
```
    Add all properties contained in the file fileName to the RuntimeInstance properties
  - setProperties
```
public void setProperties(java.util.Properties props)
```
    Add all the properties in props to the RuntimeInstance properties
  - setConfiguration
```
public 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.
    
    指定者:
    
    setConfiguration 在接口中 RuntimeServices
    
    参数:
    
    configuration -
  - addProperty
```
public 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"]
    
    指定者:
    
    addProperty 在接口中 RuntimeServices
    
    参数:
    
    key -
    
    value -
  - clearProperty
```
public void clearProperty(java.lang.String key)
```
    Clear the values pertaining to a particular property.
    
    指定者:
    
    clearProperty 在接口中 RuntimeServices
    
    参数:
    
    key - of property to clear
  - getProperty
```
public 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.
    
    指定者:
    
    getProperty 在接口中 RuntimeServices
    
    参数:
    
    key - property to return
    
    返回:
    
    Value of the property or null if it does not exist.
  - init
```
public void init(java.util.Properties p)
```
    Initialize the Velocity Runtime with a Properties object.
    
    指定者:
    
    init 在接口中 RuntimeServices
    
    参数:
    
    p - Velocity properties for initialization
  - init
```
public void init(java.lang.String configurationFile)
```
    Initialize the Velocity Runtime with the name of ExtendedProperties object.
    
    指定者:
    
    init 在接口中 RuntimeServices
    
    参数:
    
    configurationFile -
  - addDirective
```
public void addDirective(Directive directive)
```
    Programatically add a directive.
    
    参数:
    
    directive -
  - getDirective
```
public Directive getDirective(java.lang.String name)
```
    Retrieve a previously instantiated directive.
    
    指定者:
    
    getDirective 在接口中 RuntimeServices
    
    参数:
    
    name - name of the directive
    
    返回:
    
    the Directive for that name
  - removeDirective
```
public void removeDirective(java.lang.String name)
```
    Remove a directive.
    
    参数:
    
    name - name of the directive.
  - loadDirective
```
public void loadDirective(java.lang.String directiveClass)
```
    instantiates and loads the directive with some basic checks
    
    参数:
    
    directiveClass - classname of directive to load
  - createNewParser
```
public Parser createNewParser()
```
    Returns a JavaCC generated Parser.
    
    指定者:
    
    createNewParser 在接口中 RuntimeServices
    
    返回:
    
    Parser javacc generated parser
  - parse
```
public SimpleNode parse(java.lang.String string,
                        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.
    
    指定者:
    
    parse 在接口中 RuntimeServices
    
    参数:
    
    string - String to be parsed
    
    templateName - name of the template being parsed
    
    返回:
    
    A root node representing the template as an AST tree.
    
    抛出:
    
    ParseException - When the string could not be parsed as a template.
    
    从以下版本开始:
    
    1.6
  - parse
```
public 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.
    
    指定者:
    
    parse 在接口中 RuntimeServices
    
    参数:
    
    reader - Reader retrieved by a resource loader
    
    templateName - name of the template being parsed
    
    返回:
    
    A root node representing the template as an AST tree.
    
    抛出:
    
    ParseException - When the template could not be parsed.
  - parse
```
public 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.
    
    指定者:
    
    parse 在接口中 RuntimeServices
    
    参数:
    
    reader - Reader retrieved by a resource loader
    
    templateName - name of the template being parsed
    
    dumpNamespace - flag to dump the Velocimacro namespace for this template
    
    返回:
    
    A root node representing the template as an AST tree.
    
    抛出:
    
    ParseException - When the template could not be parsed.
  - evaluate
```
public 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.
    
    指定者:
    
    evaluate 在接口中 RuntimeServices
    
    参数:
    
    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
```
public 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.
    
    指定者:
    
    evaluate 在接口中 RuntimeServices
    
    参数:
    
    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
  - render
```
public boolean render(Context context,
                      java.io.Writer writer,
                      java.lang.String logTag,
                      SimpleNode nodeTree)
```
    Initializes and renders the AST SimpleNode using the context into the output writer.
    
    参数:
    
    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
    
    nodeTree - SimpleNode which is the root of the AST to be rendered
    
    返回:
    
    true if successful, false otherwise. If false, see Velocity runtime log for errors
    
    抛出:
    
    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
```
public 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.
    
    指定者:
    
    invokeVelocimacro 在接口中 RuntimeServices
    
    参数:
    
    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
```
public 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"
    
    指定者:
    
    getTemplate 在接口中 RuntimeServices
    
    参数:
    
    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.
  - initTemplate
```
public void initTemplate(Resource template)
```
  - getTemplate
```
public Template getTemplate(java.lang.String name,
                            java.lang.String encoding)
                     throws ResourceNotFoundException,
                            ParseErrorException
```
    Returns a Template from the resource manager
    
    指定者:
    
    getTemplate 在接口中 RuntimeServices
    
    参数:
    
    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.
  - initTemplate
```
public void initTemplate(Resource template,
                         java.lang.String encoding)
```
    Returns a Template from the resource manager
    
    参数:
    
    encoding - Character encoding of the template
    
    抛出:
    
    ResourceNotFoundException - if template not found from any available source.
    
    ParseErrorException - if template cannot be parsed due to syntax (or other) error.
  - getContent
```
public 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.
    
    指定者:
    
    getContent 在接口中 RuntimeServices
    
    参数:
    
    name - Name of content resource to get
    
    返回:
    
    parsed ContentResource object ready for use
    
    抛出:
    
    ResourceNotFoundException - if template not found from any available source.
    
    ParseErrorException - When the template could not be parsed.
  - getContent
```
public ContentResource getContent(java.lang.String name,
                                  java.lang.String encoding)
                           throws ResourceNotFoundException,
                                  ParseErrorException
```
    Returns a static content resource from the resource manager.
    
    指定者:
    
    getContent 在接口中 RuntimeServices
    
    参数:
    
    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 - When the template could not be parsed.
  - getLoaderNameForResource
```
public java.lang.String getLoaderNameForResource(java.lang.String resourceName)
```
    Determines if a template exists and returns name of the loader that provides it. This is a slightly less hokey way to support the Velocity.resourceExists() utility method, which was broken when per-template encoding was introduced. We can revisit this.
    
    指定者:
    
    getLoaderNameForResource 在接口中 RuntimeServices
    
    参数:
    
    resourceName - Name of template or content resource
    
    返回:
    
    class name of loader than can provide it
  - getLog
```
public Log getLog()
```
    Returns a convenient Log instance that wraps the current LogChute. Use this to log error messages. It has the usual methods.
    
    指定者:
    
    getLog 在接口中 RuntimeServices
    
    返回:
    
    A convenience Log instance that wraps the current LogChute.
    
    从以下版本开始:
    
    1.5
  - warn
```
public void warn(java.lang.Object message)
```
    已过时。 Use getLog() and call warn() on it.
    
    指定者:
    
    warn 在接口中 RuntimeLogger
    
    参数:
    
    message - The message to log.
    
    另请参阅:
    
    Log.warn(Object)
  - info
```
public void info(java.lang.Object message)
```
    已过时。 Use getLog() and call info() on it.
    
    指定者:
    
    info 在接口中 RuntimeLogger
    
    参数:
    
    message - The message to log.
    
    另请参阅:
    
    Log.info(Object)
  - error
```
public void error(java.lang.Object message)
```
    已过时。 Use getLog() and call error() on it.
    
    指定者:
    
    error 在接口中 RuntimeLogger
    
    参数:
    
    message - The message to log.
    
    另请参阅:
    
    Log.error(Object)
  - debug
```
public void debug(java.lang.Object message)
```
    已过时。 Use getLog() and call debug() on it.
    
    指定者:
    
    debug 在接口中 RuntimeLogger
    
    参数:
    
    message - The message to log.
    
    另请参阅:
    
    Log.debug(Object)
  - getString
```
public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)
```
    String property accessor method with default to hide the configuration implementation.
    
    指定者:
    
    getString 在接口中 RuntimeServices
    
    参数:
    
    key - property key
    
    defaultValue - default value to return if key not found in resource manager.
    
    返回:
    
    value of key or default
  - getVelocimacro
```
public Directive getVelocimacro(java.lang.String vmName,
                                java.lang.String templateName)
```
    Returns the appropriate VelocimacroProxy object if vmName is a valid current Velocimacro.
    
    指定者:
    
    getVelocimacro 在接口中 RuntimeServices
    
    参数:
    
    vmName - Name of velocimacro requested
    
    templateName - Name of the template that contains the velocimacro.
    
    返回:
    
    The requested VelocimacroProxy.
    
    从以下版本开始:
    
    1.6
  - getVelocimacro
```
public Directive getVelocimacro(java.lang.String vmName,
                                java.lang.String templateName,
                                java.lang.String renderingTemplate)
```
    Returns the appropriate VelocimacroProxy object if vmName is a valid current Velocimacro.
    
    指定者:
    
    getVelocimacro 在接口中 RuntimeServices
    
    参数:
    
    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
```
public 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.
    
    指定者:
    
    addVelocimacro 在接口中 RuntimeServices
    
    参数:
    
    name - Name of velocimacro
    
    macro - String form of macro body
    
    argArray - Array of strings, containing the #macro() arguments. the 0th is the name.
    
    sourceTemplate - Name of the template that contains the velocimacro.
    
    返回:
    
    True if added, false if rejected for some reason (either parameters or permission settings)
  - addVelocimacro
```
public 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. Called by bboss.org.apache.velocity.runtime.directive.processAndRegister
    
    指定者:
    
    addVelocimacro 在接口中 RuntimeServices
    
    参数:
    
    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
```
public boolean isVelocimacro(java.lang.String vmName,
                             java.lang.String templateName)
```
    Checks to see if a VM exists
    
    指定者:
    
    isVelocimacro 在接口中 RuntimeServices
    
    参数:
    
    vmName - Name of the Velocimacro.
    
    templateName - Template on which to look for the Macro.
    
    返回:
    
    True if VM by that name exists, false if not
  - dumpVMNamespace
```
public 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
    
    指定者:
    
    dumpVMNamespace 在接口中 RuntimeServices
    
    参数:
    
    namespace - Namespace to dump.
    
    返回:
    
    True if namespace was dumped successfully.
  - getString
```
public java.lang.String getString(java.lang.String key)
```
    String property accessor method to hide the configuration implementation
    
    指定者:
    
    getString 在接口中 RuntimeServices
    
    参数:
    
    key - property key
    
    返回:
    
    value of key or null
  - getInt
```
public int getInt(java.lang.String key)
```
    Int property accessor method to hide the configuration implementation.
    
    指定者:
    
    getInt 在接口中 RuntimeServices
    
    参数:
    
    key - Property key
    
    返回:
    
    value
  - getInt
```
public int getInt(java.lang.String key,
                  int defaultValue)
```
    Int property accessor method to hide the configuration implementation.
    
    指定者:
    
    getInt 在接口中 RuntimeServices
    
    参数:
    
    key - property key
    
    defaultValue - The default value.
    
    返回:
    
    value
  - getBoolean
```
public boolean getBoolean(java.lang.String key,
                          boolean def)
```
    Boolean property accessor method to hide the configuration implementation.
    
    指定者:
    
    getBoolean 在接口中 RuntimeServices
    
    参数:
    
    key - property key
    
    def - The default value if property not found.
    
    返回:
    
    value of key or default value
  - getConfiguration
```
public org.apache.commons.collections.ExtendedProperties getConfiguration()
```
    Return the velocity runtime configuration object.
    
    指定者:
    
    getConfiguration 在接口中 RuntimeServices
    
    返回:
    
    Configuration object which houses the Velocity runtime properties.
  - getIntrospector
```
public Introspector getIntrospector()
```
    Return the Introspector for this instance
    
    指定者:
    
    getIntrospector 在接口中 RuntimeServices
    
    返回:
    
    The Introspector for this instance
  - getApplicationEventCartridge
```
public EventCartridge getApplicationEventCartridge()
```
    Returns the event handlers for the application.
    
    指定者:
    
    getApplicationEventCartridge 在接口中 RuntimeServices
    
    返回:
    
    The event handlers for the application.
    
    从以下版本开始:
    
    1.5
  - getApplicationAttribute
```
public java.lang.Object getApplicationAttribute(java.lang.Object key)
```
    Gets the application attribute for the given key
    
    指定者:
    
    getApplicationAttribute 在接口中 RuntimeServices
    
    参数:
    
    key -
    
    返回:
    
    The application attribute for the given key.
  - setApplicationAttribute
```
public java.lang.Object setApplicationAttribute(java.lang.Object key,
                                                java.lang.Object o)
```
    Sets the application attribute for the given key
    
    指定者:
    
    setApplicationAttribute 在接口中 RuntimeServices
    
    参数:
    
    key -
    
    o - The new application attribute.
    
    返回:
    
    The old value of this attribute or null if it hasn't been set before.
  - getUberspect
```
public Uberspect getUberspect()
```
    Returns the Uberspect object for this Instance.
    
    指定者:
    
    getUberspect 在接口中 RuntimeServices
    
    返回:
    
    The Uberspect object for this Instance.

类 RuntimeInstance

字段概要

从接口继承的字段 bboss.org.apache.velocity.runtime.RuntimeConstants

构造器概要

方法概要

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

构造器详细资料

RuntimeInstance

方法详细资料

init

isInitialized

setProperty

setProperties

setProperties

setConfiguration

addProperty

clearProperty

getProperty

init

init

addDirective

getDirective

removeDirective

loadDirective

createNewParser

parse

parse

parse

evaluate

evaluate

render

invokeVelocimacro

getTemplate

initTemplate

getTemplate

initTemplate

getContent

getContent

getLoaderNameForResource

getLog

warn

info

error

debug

getString

getVelocimacro

getVelocimacro

addVelocimacro

addVelocimacro

isVelocimacro

dumpVMNamespace

getString

getInt

getInt

getBoolean

getConfiguration

getIntrospector

getApplicationEventCartridge

getApplicationAttribute

setApplicationAttribute

getUberspect