| java.lang.Object
 org.apache.velocity.runtime.RuntimeInstance
| RuntimeInstance | | public class RuntimeInstance implements RuntimeConstants,RuntimeServices(Code) | | 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.
-----------------------------------------------------------------------
author:
Jason van Zyl
author:
Jeff Bowden
author:
Geir Magusson Jr.
version:
$Id: RuntimeInstance.java 474051 2006-11-12 21:42:02Z henning $ |
| Constructor Summary | |
| public | RuntimeInstance()
Creates a new RuntimeInstance object. |
| Method Summary | |
| public void | addProperty(String key, Object value)
Add a property to the configuration. | | public boolean | addVelocimacro(String name, String macro, String argArray, String sourceTemplate)
Adds a new Velocimacro. | | public void | clearProperty(String key)
Clear the values pertaining to a particular
property. | | public Parser | createNewParser()
Returns a JavaCC generated Parser. | | public void | debug(Object message)
| | public boolean | dumpVMNamespace(String namespace)
tells the vmFactory to dump the specified namespace. | | public void | error(Object message)
| | public Object | getApplicationAttribute(Object key)
| | public EventCartridge | getApplicationEventCartridge()
Returns the event handlers for the application. | | public boolean | getBoolean(String key, boolean def)
Boolean property accessor method to hide the configuration implementation.
Parameters:
key - property key
Parameters:
def - The default value if property not found. | | public ExtendedProperties | getConfiguration()
Return the velocity runtime configuration object. | | public ContentResource | getContent(String name)
Returns a static content resource from the
resource manager. | | public ContentResource | getContent(String name, String encoding)
Returns a static content resource from the
resource manager. | | public int | getInt(String key)
Int property accessor method to hide the configuration implementation. | | public int | getInt(String key, int defaultValue)
Int property accessor method to hide the configuration implementation.
Parameters:
key - property key
Parameters:
defaultValue - The default value. | | public Introspector | getIntrospector()
| | public String | getLoaderNameForResource(String resourceName)
Determines if a template exists and returns name of the loader that
provides it. | | public Log | getLog()
Returns a convenient Log instance that wraps the current LogChute.
Use this to log error messages. | | public Object | getProperty(String key)
Allows an external caller to get a property. | | public String | getString(String key, String defaultValue)
String property accessor method with default to hide the
configuration implementation.
Parameters:
key - property key
Parameters:
defaultValue - default value to return if key notfound in resource manager. | | public String | getString(String key)
| | public Template | getTemplate(String name)
Returns a Template from the resource manager.
This method assumes that the character encoding of the
template is set by the input.encoding
property. | | public Template | getTemplate(String name, String encoding)
| | public Uberspect | getUberspect()
Returns the Uberspect object for this Instance. | | public Directive | getVelocimacro(String vmName, String templateName)
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
Parameters:
vmName - Name of velocimacro requested
Parameters:
templateName - Name of the template that contains the velocimacro. | | public void | info(Object message)
| | public synchronized void | init()
This is the primary initialization method in the Velocity
Runtime. | | public void | init(Properties p)
Initialize the Velocity Runtime with a Properties
object. | | public void | init(String configurationFile)
Initialize the Velocity Runtime with the name of
ExtendedProperties object. | | public boolean | isInitialized()
Returns true if the RuntimeInstance has been successfully initialized. | | public boolean | isVelocimacro(String vmName, String templateName)
Checks to see if a VM exists
Parameters:
vmName - Name of the Velocimacro.
Parameters:
templateName - Template on which to look for the Macro. | | public SimpleNode | parse(Reader reader, String templateName)
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. | | public SimpleNode | parse(Reader reader, String templateName, boolean dumpNamespace)
Parse the input and return the root of the AST node structure. | | public Object | setApplicationAttribute(Object key, Object o)
Sets the application attribute for the given key
Parameters:
key -
Parameters:
o - The new application attribute. | | public void | setConfiguration(ExtendedProperties configuration)
Allow an external system to set an ExtendedProperties
object to use. | | public void | setProperty(String key, Object value)
Allows an external system to set a property in
the Velocity Runtime. | | public void | warn(Object message)
|
| RuntimeInstance | | public RuntimeInstance()(Code) | | Creates a new RuntimeInstance object.
|
| addProperty | | public void addProperty(String key, Object value)(Code) | | 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"]
Parameters:
key -
Parameters:
value - |
| addVelocimacro | | public boolean addVelocimacro(String name, String macro, String argArray, String sourceTemplate)(Code) | | Adds a new Velocimacro. Usually called by Macro only while parsing.
Parameters:
name - Name of velocimacro
Parameters:
macro - String form of macro body
Parameters:
argArray - Array of strings, containing the#macro() arguments. the 0th is the name.
Parameters:
sourceTemplate - Name of the template that contains the velocimacro. True if added, false if rejected for somereason (either parameters or permission settings) |
| clearProperty | | public void clearProperty(String key)(Code) | | Clear the values pertaining to a particular
property.
Parameters:
key - of property to clear |
| createNewParser | | public Parser createNewParser()(Code) | | Returns a JavaCC generated Parser.
Parser javacc generated parser |
| dumpVMNamespace | | public boolean dumpVMNamespace(String namespace)(Code) | | tells the vmFactory to dump the specified namespace. This is to support
clearing the VM list when in inline-VM-local-scope mode
Parameters:
namespace - Namespace to dump. True if namespace was dumped successfully. |
| getApplicationAttribute | | public Object getApplicationAttribute(Object key)(Code) | | Gets the application attribute for the given key
Parameters:
key - The application attribute for the given key. |
| getApplicationEventCartridge | | public EventCartridge getApplicationEventCartridge()(Code) | | Returns the event handlers for the application.
The event handlers for the application. |
| getBoolean | | public boolean getBoolean(String key, boolean def)(Code) | | Boolean property accessor method to hide the configuration implementation.
Parameters:
key - property key
Parameters:
def - The default value if property not found. value of key or default value |
| getConfiguration | | public ExtendedProperties getConfiguration()(Code) | | Return the velocity runtime configuration object.
Configuration object which houses the Velocity runtimeproperties. |
| getInt | | public int getInt(String key)(Code) | | Int property accessor method to hide the configuration implementation.
Parameters:
key - Property key value |
| getInt | | public int getInt(String key, int defaultValue)(Code) | | Int property accessor method to hide the configuration implementation.
Parameters:
key - property key
Parameters:
defaultValue - The default value. value |
| getIntrospector | | public Introspector getIntrospector()(Code) | | Return the Introspector for this instance
The Introspector for this instance |
| getLoaderNameForResource | | public String getLoaderNameForResource(String resourceName)(Code) | | 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.
Parameters:
resourceName - Name of template or content resource class name of loader than can provide it |
| getLog | | public Log getLog()(Code) | | Returns a convenient Log instance that wraps the current LogChute.
Use this to log error messages. It has the usual methods.
A convenience Log instance that wraps the current LogChute. |
| getProperty | | public Object getProperty(String key)(Code) | | 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.
Parameters:
key - property to return Value of the property or null if it does not exist. |
| getString | | public String getString(String key, String defaultValue)(Code) | | String property accessor method with default to hide the
configuration implementation.
Parameters:
key - property key
Parameters:
defaultValue - default value to return if key notfound in resource manager. value of key or default |
| getString | | public String getString(String key)(Code) | | String property accessor method to hide the configuration implementation
Parameters:
key - property key value of key or null |
| getUberspect | | public Uberspect getUberspect()(Code) | | Returns the Uberspect object for this Instance.
The Uberspect object for this Instance. |
| getVelocimacro | | public Directive getVelocimacro(String vmName, String templateName)(Code) | | Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
Parameters:
vmName - Name of velocimacro requested
Parameters:
templateName - Name of the template that contains the velocimacro. The requested VelocimacroProxy. |
| init | | public synchronized void init() throws Exception(Code) | | 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
throws:
Exception - When an error occured during initialization. |
| init | | public void init(Properties p) throws Exception(Code) | | Initialize the Velocity Runtime with a Properties
object.
Parameters:
p -
throws:
Exception - When an error occurs during initialization. |
| init | | public void init(String configurationFile) throws Exception(Code) | | Initialize the Velocity Runtime with the name of
ExtendedProperties object.
Parameters:
configurationFile -
throws:
Exception - When an error occurs during initialization. |
| isInitialized | | public boolean isInitialized()(Code) | | Returns true if the RuntimeInstance has been successfully initialized.
True if the RuntimeInstance has been successfully initialized. |
| isVelocimacro | | public boolean isVelocimacro(String vmName, String templateName)(Code) | | Checks to see if a VM exists
Parameters:
vmName - Name of the Velocimacro.
Parameters:
templateName - Template on which to look for the Macro. True if VM by that name exists, false if not |
| parse | | public SimpleNode parse(Reader reader, String templateName) throws ParseException(Code) | | 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.
Parameters:
reader - Reader retrieved by a resource loader
Parameters:
templateName - name of the template being parsed A root node representing the template as an AST tree.
throws:
ParseException - When the template could not be parsed. |
| parse | | public SimpleNode parse(Reader reader, String templateName, boolean dumpNamespace) throws ParseException(Code) | | Parse the input and return the root of the AST node structure.
Parameters:
reader - Reader retrieved by a resource loader
Parameters:
templateName - name of the template being parsed
Parameters:
dumpNamespace - flag to dump the Velocimacro namespace for this template A root node representing the template as an AST tree.
throws:
ParseException - When the template could not be parsed. |
| setApplicationAttribute | | public Object setApplicationAttribute(Object key, Object o)(Code) | | Sets the application attribute for the given key
Parameters:
key -
Parameters:
o - The new application attribute. The old value of this attribute or null if it hasn't been set before. |
| setConfiguration | | public void setConfiguration(ExtendedProperties configuration)(Code) | | 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.
Parameters:
configuration - |
| setProperty | | public void setProperty(String key, Object value)(Code) | | Allows an external system to set a property in
the Velocity Runtime.
Parameters:
key - property key
Parameters:
value - property value |
|
|