| org.apache.velocity.runtime.RuntimeServices
All known Subclasses: org.apache.velocity.runtime.RuntimeInstance,
| RuntimeServices | | public interface RuntimeServices extends RuntimeLogger(Code) | | 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.
author:
Geir Magusson Jr.
version:
$Id: RuntimeServices.java 463298 2006-10-12 16:10:32Z henning $ |
| 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()
Create a new parser instance. | | public boolean | dumpVMNamespace(String namespace)
tells the vmFactory to dump the specified namespace. | | public Object | getApplicationAttribute(Object key)
Return the specified application attribute.
Parameters:
key - The name of the attribute to retrieve. | | 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. | | 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. | | public Introspector | getIntrospector()
Returns the configured method introspection/reflection
implementation. | | public String | getLoaderNameForResource(String resourceName)
Determines is 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. | | 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 configured class introspection/reflection
implemenation. | | 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 namespace. | | public 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)
| | 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 value)
Set the specified application attribute.
Parameters:
key - The name of the attribute to set.
Parameters:
value - The attribute value to set. | | 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. |
| 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 - boolean 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) | | Create a new parser instance.
A new parser instance. |
| 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 - True if the Namespace was dumped. |
| getApplicationAttribute | | public Object getApplicationAttribute(Object key)(Code) | | Return the specified application attribute.
Parameters:
key - The name of the attribute to retrieve. The value of the attribute. |
| 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 - default default value if property not found boolean value of key or default value |
| getConfiguration | | public ExtendedProperties getConfiguration()(Code) | | Return the velocity runtime configuration object.
ExtendedProperties configuration object which housesthe velocity runtime properties. |
| getInt | | public int getInt(String key)(Code) | | Int property accessor method to hide the configuration implementation.
Parameters:
key - property key int 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 - default value int value |
| getIntrospector | | public Introspector getIntrospector()(Code) | | Returns the configured method introspection/reflection
implementation.
The configured method introspection/reflectionimplementation. |
| getLoaderNameForResource | | public String getLoaderNameForResource(String resourceName)(Code) | | 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.
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.
A log object. |
| 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 The value. |
| 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. String 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 configured class introspection/reflection
implemenation.
The current Uberspect object. |
| 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 namespace. VelocimacroProxy |
| init | | public 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
- Parser Pool
- Global Cache
- Static Content Include System
- Velocimacro System
throws:
Exception - |
| init | | public void init(String configurationFile) throws Exception(Code) | | Initialize the Velocity Runtime with the name of
ExtendedProperties object.
Parameters:
configurationFile -
throws:
Exception - |
| 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 velocimacro
Parameters:
templateName - boolean 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 - inputstream retrieved by a resource loader
Parameters:
templateName - name of the template being parsed The AST representing the template.
throws:
ParseException - |
| 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 - inputstream retrieved by a resource loader
Parameters:
templateName - name of the template being parsed
Parameters:
dumpNamespace - flag to dump the Velocimacro namespace for this template The AST representing the template.
throws:
ParseException - |
| setApplicationAttribute | | public Object setApplicationAttribute(Object key, Object value)(Code) | | Set the specified application attribute.
Parameters:
key - The name of the attribute to set.
Parameters:
value - The attribute value to set. the displaced attribute value |
| 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 |
|
|