org.apache.velocity.runtime

Class Runtime

public class Runtime extends Object implements RuntimeConstants

Deprecated: Use RuntimeInstance or RuntimeSingleton instead.

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:
 Runtime.setProperty(Runtime.FILE_RESOURCE_LOADER_PATH, templatePath);
 Runtime.setProperty(Runtime.RUNTIME_LOG, pathToVelocityLog);
 Runtime.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
 -----------------------------------------------------------------------
 Runtime.init()
 
 If Runtime.init() is called by itself the Runtime will
 initialize with a set of default values.
 -----------------------------------------------------------------------
 Runtime.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.
 -----------------------------------------------------------------------
 

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

Author: Jason van Zyl Jeff Bowden Geir Magusson Jr.

See Also: RuntimeInstance RuntimeSingleton

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

Method Detail

addProperty

public static 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 static 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 static void clearProperty(String key)
Clear the values pertaining to a particular property.

Parameters: String key of property to clear

debug

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

Parameters: Object message to log

dumpVMNamespace

public static 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 static void error(Object message)
Log an error message.

Parameters: Object message to log

getBoolean

public static 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 static ExtendedProperties getConfiguration()
Return the velocity runtime configuration object.

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

getContent

public static 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 static 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 static int getInt(String key)
Int property accessor method to hide the configuration implementation.

Parameters: String key property key

Returns: int value

getInt

public static 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

getLoaderNameForResource

public static 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 static 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 static 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 static 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 static 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 static 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

getVelocimacro

public static 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

info

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

Parameters: Object message to log

init

public static void init()

init

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

Parameters: Properties

init

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

Parameters: Properties

isVelocimacro

public static 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 static 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 static 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 static 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 static 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

warn

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

Parameters: Object message to log

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