org.apache.velocity.runtime

Interface RuntimeServices

Known Implementing Classes:
RuntimeInstance

public interface RuntimeServices

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.4 2002/01/03 12:40:23 geirm Exp $

Author:
Geir Magusson Jr.

Method Summary

void
addProperty(String key, Object value)
Add a property to the configuration.
boolean
addVelocimacro(String name, String macro, argArray[] , String sourceTemplate)
Adds a new Velocimacro.
void
clearProperty(String key)
Clear the values pertaining to a particular property.
void
debug(Object message)
Log a debug message.
boolean
dumpVMNamespace(String namespace)
tells the vmFactory to dump the specified namespace.
void
error(Object message)
Log an error message.
Object
getApplicationAttribute(Object key)
boolean
getBoolean(String key, boolean def)
Boolean property accessor method to hide the configuration implementation.
ExtendedProperties
getConfiguration()
Return the velocity runtime configuration object.
ContentResource
getContent(String name)
Returns a static content resource from the resource manager.
ContentResource
getContent(String name, String encoding)
Returns a static content resource from the resource manager.
int
getInt(String key)
Int property accessor method to hide the configuration implementation.
int
getInt(String key, int defaultValue)
Int property accessor method to hide the configuration implementation.
Introspector
getIntrospector()
String
getLoaderNameForResource(String resourceName)
Determines is a template exists, and returns name of the loader that provides it.
Object
getProperty(String key)
Allows an external caller to get a property.
String
getString(String key)
String property accessor method to hide the configuration implementation
String
getString(String key, String defaultValue)
String property accessor method with default to hide the configuration implementation.
Template
getTemplate(String name)
Returns a Template from the resource manager.
Template
getTemplate(String name, String encoding)
Returns a Template from the resource manager
Directive
getVelocimacro(String vmName, String templateName)
Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
void
info(Object message)
Log an info message.
void
init()
void
init(Properties p)
Initialize the Velocity Runtime with a Properties object.
void
init(String configurationFile)
Initialize the Velocity Runtime with the name of ExtendedProperties object.
boolean
isVelocimacro(String vmName, String templateName)
Checks to see if a VM exists
SimpleNode
parse(Reader reader, String templateName)
Parse the input and return the root of AST node structure.
SimpleNode
parse(Reader reader, String templateName, boolean dumpNamespace)
Parse the input and return the root of the AST node structure.
void
setConfiguration(ExtendedProperties configuration)
Allow an external system to set an ExtendedProperties object to use.
void
setProperty(String key, Object value)
Allows an external system to set a property in the Velocity Runtime.
void
warn(Object message)
Log a warning message.

Method Details

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:


addVelocimacro

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

Parameters:

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:


debug

public void debug(Object message)
Log a debug message.

Parameters:


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


error

public void error(Object message)
Log an error message.

Parameters:


getApplicationAttribute

public Object getApplicationAttribute(Object key)


getBoolean

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

Parameters:

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)
            throws ResourceNotFoundException,
                   ParseErrorException,
                   Exception
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)
            throws ResourceNotFoundException,
                   ParseErrorException,
                   Exception
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:

Returns:
int value


getInt

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

Parameters:
key - property key

Returns:
int value


getIntrospector

public Introspector getIntrospector()


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 property accessor method to hide the configuration implementation

Parameters:
key - property key

Returns:
value of key or null


getString

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

Parameters:

Returns:
String value of key or default


getTemplate

public Template getTemplate(String name)
            throws ResourceNotFoundException,
                   ParseErrorException,
                   Exception
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.


getTemplate

public Template getTemplate(String name,
                            String encoding)
            throws ResourceNotFoundException,
                   ParseErrorException,
                   Exception
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.


getVelocimacro

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

Parameters:

Returns:
String VelocimacroProxy


info

public void info(Object message)
Log an info message.

Parameters:


init

public void init()
            throws Exception


init

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

Parameters:


init

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

Parameters:


isVelocimacro

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

Parameters:

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


parse

public SimpleNode parse(Reader reader,
                        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.

Parameters:


parse

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

Parameters:
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:


setProperty

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

Parameters:


warn

public void warn(Object message)
Log a warning message.

Parameters:


Copyright © 2003 Apache Software Foundation. All Rights Reserved.