org.apache.velocity.runtime

Interface RuntimeServices

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.

Version: $Id: RuntimeServices.java,v 1.7.4.1 2004/03/03 23:22:55 geirm Exp $

Author: Geir Magusson Jr.

Method Summary
voidaddProperty(String key, Object value)
Add a property to the configuration.
booleanaddVelocimacro(String name, String macro, String[] argArray, String sourceTemplate)
Adds a new Velocimacro.
voidclearProperty(String key)
Clear the values pertaining to a particular property.
booleandumpVMNamespace(String namespace)
tells the vmFactory to dump the specified namespace.
ObjectgetApplicationAttribute(Object key)
Return the specified applcation attribute.
booleangetBoolean(String key, boolean def)
Boolean property accessor method to hide the configuration implementation.
ExtendedPropertiesgetConfiguration()
Return the velocity runtime configuration object.
ContentResourcegetContent(String name)
Returns a static content resource from the resource manager.
ContentResourcegetContent(String name, String encoding)
Returns a static content resource from the resource manager.
intgetInt(String key)
Int property accessor method to hide the configuration implementation.
intgetInt(String key, int defaultValue)
Int property accessor method to hide the configuration implementation.
IntrospectorgetIntrospector()
Returns the configured method introspection/reflection implemenation.
StringgetLoaderNameForResource(String resourceName)
Determines is a template exists, and returns name of the loader that provides it.
ObjectgetProperty(String key)
Allows an external caller to get a property.
StringgetString(String key, String defaultValue)
String property accessor method with default to hide the configuration implementation.
StringgetString(String key)
String property accessor method to hide the configuration implementation
TemplategetTemplate(String name)
Returns a Template from the resource manager.
TemplategetTemplate(String name, String encoding)
Returns a Template from the resource manager
UberspectgetUberspect()
Returns the configured class introspection/reflection implemenation.
DirectivegetVelocimacro(String vmName, String templateName)
Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
voidinit()
voidinit(Properties p)
Initialize the Velocity Runtime with a Properties object.
voidinit(String configurationFile)
Initialize the Velocity Runtime with the name of ExtendedProperties object.
booleanisVelocimacro(String vmName, String templateName)
Checks to see if a VM exists
SimpleNodeparse(Reader reader, String templateName)
Parse the input and return the root of AST node structure.
SimpleNodeparse(Reader reader, String templateName, boolean dumpNamespace)
Parse the input and return the root of the AST node structure.
voidsetConfiguration(ExtendedProperties configuration)
Allow an external system to set an ExtendedProperties object to use.
voidsetProperty(String key, Object value)
Allows an external system to set a property in the Velocity Runtime.

Method Detail

addProperty

public void addProperty(String key, 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"]

Parameters: String key String value

addVelocimacro

public boolean addVelocimacro(String name, String macro, String[] argArray, String sourceTemplate)
Adds a new Velocimacro. Usually called by Macro only while parsing.

Parameters: String name Name of velocimacro String macro String form of macro body String argArray Array of strings, containing the #macro() arguments. the 0th is the name.

Returns: boolean True if added, false if rejected for some reason (either parameters or permission settings)

clearProperty

public void clearProperty(String key)
Clear the values pertaining to a particular property.

Parameters: String key of property to clear

dumpVMNamespace

public boolean dumpVMNamespace(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

getApplicationAttribute

public Object getApplicationAttribute(Object key)
Return the specified applcation attribute.

Parameters: key The name of the attribute to retrieve.

getBoolean

public boolean getBoolean(String key, boolean def)
Boolean property accessor method to hide the configuration implementation.

Parameters: String key property key boolean default default value if property not found

Returns: boolean value of key or default value

getConfiguration

public ExtendedProperties getConfiguration()
Return the velocity runtime configuration object.

Returns: ExtendedProperties configuration object which houses the velocity runtime properties.

getContent

public ContentResource getContent(String name)
Returns a static content resource from the resource manager. Uses the current value if INPUT_ENCODING as the character encoding.

Parameters: name Name of content resource to get

Returns: parsed ContentResource object ready for use

Throws: ResourceNotFoundException if template not found from any available source.

getContent

public ContentResource getContent(String name, String encoding)
Returns a static content resource from the resource manager.

Parameters: name Name of content resource to get encoding Character encoding to use

Returns: parsed ContentResource object ready for use

Throws: ResourceNotFoundException if template not found from any available source.

getInt

public int getInt(String key)
Int property accessor method to hide the configuration implementation.

Parameters: String key property key

Returns: int value

getInt

public int getInt(String key, int defaultValue)
Int property accessor method to hide the configuration implementation.

Parameters: key property key int default value

Returns: int value

getIntrospector

public Introspector getIntrospector()
Returns the configured method introspection/reflection implemenation.

getLoaderNameForResource

public String getLoaderNameForResource(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.

Parameters: resourceName Name of template or content resource

Returns: class name of loader than can provide it

getProperty

public Object getProperty(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.

Parameters: key property to return

getString

public String getString(String key, String defaultValue)
String property accessor method with default to hide the configuration implementation.

Parameters: String key property key String defaultValue default value to return if key not found in resource manager.

Returns: String value of key or default

getString

public String getString(String key)
String property accessor method to hide the configuration implementation

Parameters: key property key

Returns: value of key or null

getTemplate

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. The default is "ISO-8859-1"

Parameters: name The file name of the desired template.

Returns: The template.

Throws: ResourceNotFoundException if template not found from any available source. ParseErrorException if template cannot be parsed due to syntax (or other) error. Exception if an error occurs in template initialization

getTemplate

public Template getTemplate(String name, String encoding)
Returns a Template from the resource manager

Parameters: name The name of the desired template. encoding Character encoding of the template

Returns: The template.

Throws: ResourceNotFoundException if template not found from any available source. ParseErrorException if template cannot be parsed due to syntax (or other) error. Exception if an error occurs in template initialization

getUberspect

public Uberspect getUberspect()
Returns the configured class introspection/reflection implemenation.

getVelocimacro

public Directive getVelocimacro(String vmName, String templateName)
Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.

Parameters: String vmName Name of velocimacro requested

Returns: String VelocimacroProxy

init

public void init()

init

public void init(Properties p)
Initialize the Velocity Runtime with a Properties object.

Parameters: Properties

init

public void init(String configurationFile)
Initialize the Velocity Runtime with the name of ExtendedProperties object.

Parameters: Properties

isVelocimacro

public boolean isVelocimacro(String vmName, String templateName)
Checks to see if a VM exists

Parameters: name Name of velocimacro

Returns: boolean True if VM by that name exists, false if not

parse

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. 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: InputStream inputstream retrieved by a resource loader String name of the template being parsed

parse

public SimpleNode parse(Reader reader, String templateName, boolean dumpNamespace)
Parse the input and return the root of the AST node structure.

Parameters: InputStream inputstream retrieved by a resource loader String name of the template being parsed dumpNamespace flag to dump the Velocimacro namespace for this template

setConfiguration

public void setConfiguration(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.

Parameters: ExtendedProperties configuration

setProperty

public void setProperty(String key, Object value)
Allows an external system to set a property in the Velocity Runtime.

Parameters: String property key String property value

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.