org.apache.velocity.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 $
See Also: RuntimeInstance RuntimeSingleton
Method Summary | |
---|---|
static void | addProperty(String key, Object value)
Add a property to the configuration. |
static boolean | addVelocimacro(String name, String macro, String[] argArray, String sourceTemplate)
Adds a new Velocimacro. |
static void | clearProperty(String key)
Clear the values pertaining to a particular
property.
|
static void | debug(Object message)
Log a debug message.
|
static boolean | dumpVMNamespace(String namespace)
tells the vmFactory to dump the specified namespace. |
static void | error(Object message)
Log an error message.
|
static boolean | getBoolean(String key, boolean def)
Boolean property accessor method to hide the configuration implementation.
|
static ExtendedProperties | getConfiguration()
Return the velocity runtime configuration object.
|
static ContentResource | getContent(String name)
Returns a static content resource from the
resource manager. |
static ContentResource | getContent(String name, String encoding)
Returns a static content resource from the
resource manager.
|
static int | getInt(String key)
Int property accessor method to hide the configuration implementation.
|
static int | getInt(String key, int defaultValue)
Int property accessor method to hide the configuration implementation.
|
static String | getLoaderNameForResource(String resourceName)
Determines is a template exists, and returns name of the loader that
provides it. |
static Object | getProperty(String key)
Allows an external caller to get a property. |
static String | getString(String key, String defaultValue)
String property accessor method with default to hide the
configuration implementation.
|
static String | getString(String key)
String property accessor method to hide the configuration implementation |
static Template | getTemplate(String name)
Returns a Template from the resource manager.
|
static Template | getTemplate(String name, String encoding)
Returns a Template from the resource manager
|
static Directive | getVelocimacro(String vmName, String templateName)
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
|
static void | info(Object message)
Log an info message.
|
static void | init() |
static void | init(Properties p)
Initialize the Velocity Runtime with a Properties
object.
|
static void | init(String configurationFile)
Initialize the Velocity Runtime with the name of
ExtendedProperties object.
|
static boolean | isVelocimacro(String vmName, String templateName)
Checks to see if a VM exists
|
static SimpleNode | parse(Reader reader, String templateName)
Parse the input and return the root of
AST node structure.
|
static SimpleNode | parse(Reader reader, String templateName, boolean dumpNamespace)
Parse the input and return the root of the AST node structure.
|
static void | setConfiguration(ExtendedProperties configuration)
Allow an external system to set an ExtendedProperties
object to use. |
static void | setProperty(String key, Object value)
Allows an external system to set a property in
the Velocity Runtime.
|
static void | warn(Object message)
Log a warning message.
|
Parameters: String key String value
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)
Parameters: String key of property to clear
Parameters: Object message to log
Parameters: Object message to log
Parameters: String key property key boolean default default value if property not found
Returns: boolean value of key or default value
Returns: ExtendedProperties configuration object which houses the velocity runtime properties.
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.
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.
Parameters: String key property key
Returns: int value
Parameters: key property key int default value
Returns: int value
Parameters: resourceName Name of template or content resource
Returns: class name of loader than can provide it
Parameters: key property to return
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
Parameters: key property key
Returns: value of key or null
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
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
Parameters: String vmName Name of velocimacro requested
Returns: String VelocimacroProxy
Parameters: Object message to log
Parameters: Properties
Parameters: Properties
Parameters: name Name of velocimacro
Returns: boolean True if VM by that name exists, false if not
Parameters: InputStream inputstream retrieved by a resource loader String name of the template being parsed
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
Parameters: ExtendedProperties configuration
Parameters: String property key String property value
Parameters: Object message to log