| java.lang.Object
 org.apache.velocity.runtime.Runtime
| Runtime | | public class Runtime implements RuntimeConstants(Code) | | 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.
-----------------------------------------------------------------------
author:
Jason van Zyl
author:
Jeff Bowden
author:
Geir Magusson Jr.
See Also: org.apache.velocity.runtime.RuntimeInstance
See Also: org.apache.velocity.runtime.RuntimeSingleton
version:
$Id: Runtime.java 463298 2006-10-12 16:10:32Z henning $ |
| Method Summary | |
| public static void | addProperty(String key, Object value)
Add a property to the configuration. | | public static boolean | addVelocimacro(String name, String macro, String argArray, String sourceTemplate)
Adds a new Velocimacro. | | public static void | clearProperty(String key)
Clear the values pertaining to a particular
property. | | public static void | debug(Object message)
Log a debug message. | | public static boolean | dumpVMNamespace(String namespace)
tells the vmFactory to dump the specified namespace. | | public static void | error(Object message)
Log an error message. | | public static boolean | getBoolean(String key, boolean def)
Boolean property accessor method to hide the configuration implementation. | | public static ExtendedProperties | getConfiguration()
Return the velocity runtime configuration object. | | public static ContentResource | getContent(String name)
Returns a static content resource from the
resource manager. | | public static ContentResource | getContent(String name, String encoding)
Returns a static content resource from the
resource manager. | | public static int | getInt(String key)
Int property accessor method to hide the configuration implementation.
Parameters:
key - A property key. | | public static int | getInt(String key, int defaultValue)
Int property accessor method to hide the configuration implementation. | | public static String | getLoaderNameForResource(String resourceName)
Determines is a template exists, and returns name of the loader that
provides it. | | public static Object | getProperty(String key)
Allows an external caller to get a property. | | public static String | getString(String key, String defaultValue)
String property accessor method with default to hide the
configuration implementation.
Parameters:
key - A property key.
Parameters:
defaultValue - default value to return if key notfound in resource manager. | | public static String | getString(String key)
| | 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. | | public static Template | getTemplate(String name, String encoding)
| | public static 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 - The template from which the macro is requested. | | public static void | info(Object message)
Log an info message. | | public static synchronized void | init()
This is the primary initialization method in the Velocity
Runtime. | | public static void | init(Properties p)
Initialize the Velocity Runtime with a Properties
object. | | public static void | init(String configurationFile)
Initialize the Velocity Runtime with the name of
ExtendedProperties object. | | public static boolean | isVelocimacro(String vmName, String templateName)
Checks to see if a VM exists
Parameters:
vmName - The name of velocimacro.
Parameters:
templateName - The template from which the macro is requested. | | 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. | | public static SimpleNode | parse(Reader reader, String templateName, boolean dumpNamespace)
Parse the input and return the root of the AST node structure.
See Also: Runtime.parse(Reader,String)
Parameters:
reader - A reader returning the template input stream.
Parameters:
templateName - name of the template being parsed
Parameters:
dumpNamespace - flag to dump the Velocimacro namespace for this template. | | public static void | setConfiguration(ExtendedProperties configuration)
Allow an external system to set an ExtendedProperties
object to use. | | public static void | setProperty(String key, Object value)
Allows an external system to set a property in
the Velocity Runtime. | | public static void | warn(Object message)
Log a warning message. |
| addProperty | | public static 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 - A property key.
Parameters:
value - The property value. |
| addVelocimacro | | public static 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 a new velocimacro.
Parameters:
macro - String form of the macro body.
Parameters:
argArray - Array of strings, containing the#macro() arguments. the 0th argument is the name.
Parameters:
sourceTemplate - The template from which the macro is requested. boolean True if added, false if rejected for somereason (either parameters or permission settings) |
| clearProperty | | public static void clearProperty(String key)(Code) | | Clear the values pertaining to a particular
property.
Parameters:
key - Name of the property to clear. |
| debug | | public static void debug(Object message)(Code) | | Log a debug message.
Parameters:
message - message to log |
| dumpVMNamespace | | public static 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 - The namespace to dump. True if the namespace has been dumped. |
| error | | public static void error(Object message)(Code) | | Log an error message.
Parameters:
message - message to log |
| getBoolean | | public static 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 static ExtendedProperties getConfiguration()(Code) | | Return the velocity runtime configuration object.
ExtendedProperties configuration object which housesthe velocity runtime properties. |
| getInt | | public static int getInt(String key)(Code) | | Int property accessor method to hide the configuration implementation.
Parameters:
key - A property key. Integer value for this key. |
| getInt | | public static int getInt(String key, int defaultValue)(Code) | | Int property accessor method to hide the configuration implementation.
Parameters:
key - property key
Parameters:
defaultValue - default value The integer value. |
| getLoaderNameForResource | | public static 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 |
| getProperty | | public static 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 property value or null. |
| getString | | public static String getString(String key, String defaultValue)(Code) | | String property accessor method with default to hide the
configuration implementation.
Parameters:
key - A property key.
Parameters:
defaultValue - default value to return if key notfound in resource manager. The property value of of key or default. |
| getString | | public static String getString(String key)(Code) | | String property accessor method to hide the configuration implementation
Parameters:
key - property key value of key or null |
| getVelocimacro | | public static 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 - The template from which the macro is requested. A VelocimacroProxy object for the macro. |
| info | | public static void info(Object message)(Code) | | Log an info message.
Parameters:
message - message to log |
| init | | public static synchronized 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 - When init fails for any reason. |
| init | | public static void init(Properties p) throws Exception(Code) | | Initialize the Velocity Runtime with a Properties
object.
Parameters:
p - The properties used for initializiation.
throws:
Exception - When a problem occurs during init. |
| init | | public static void init(String configurationFile) throws Exception(Code) | | Initialize the Velocity Runtime with the name of
ExtendedProperties object.
Parameters:
configurationFile - The name of a properties file.
throws:
Exception - When a problem occurs during init. |
| isVelocimacro | | public static boolean isVelocimacro(String vmName, String templateName)(Code) | | Checks to see if a VM exists
Parameters:
vmName - The name of velocimacro.
Parameters:
templateName - The template from which the macro is requested. boolean True if VM by that name exists, false if not |
| parse | | public static 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 - A reader returning the template input stream.
Parameters:
templateName - name of the template being parsed The root node of an AST structure for the template input stream.
throws:
ParseException - When the input stream is not parsable. |
| parse | | public static SimpleNode parse(Reader reader, String templateName, boolean dumpNamespace) throws ParseException(Code) | | Parse the input and return the root of the AST node structure.
See Also: Runtime.parse(Reader,String)
Parameters:
reader - A reader returning the template input stream.
Parameters:
templateName - name of the template being parsed
Parameters:
dumpNamespace - flag to dump the Velocimacro namespace for this template. The root node of an AST structure for the template input stream.
throws:
ParseException - When the input stream is not parsable. |
| setConfiguration | | public static 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 - A configuration object. |
| setProperty | | public static void setProperty(String key, Object value)(Code) | | Allows an external system to set a property in
the Velocity Runtime.
Parameters:
key - The property key.
Parameters:
value - The property value. |
| warn | | public static void warn(Object message)(Code) | | Log a warning message.
Parameters:
message - message to log |
|
|