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:
| Method from org.apache.velocity.runtime.RuntimeSingleton Detail: |
public static void addProperty(String key,
Object value) {
ri.addProperty( key, 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"] |
public static boolean addVelocimacro(String name,
String macro,
String[] argArray,
String sourceTemplate) {
return ri.addVelocimacro( name, macro, argArray, sourceTemplate );
}
Adds a new Velocimacro. Usually called by Macro only while parsing. |
public static void clearProperty(String key) {
ri.clearProperty( key );
}
Clear the values pertaining to a particular
property. |
public static void debug(Object message) {
getLog().debug(message);
} Deprecated! Use - getLog() and call debug() on it.
|
public static boolean dumpVMNamespace(String namespace) {
return ri.dumpVMNamespace( namespace );
}
tells the vmFactory to dump the specified namespace. This is to support
clearing the VM list when in inline-VM-local-scope mode |
public static void error(Object message) {
getLog().error(message);
} Deprecated! Use - getLog() and call error() on it.
|
public static Object getApplicationAttribute(Object key) {
return ri.getApplicationAttribute(key);
}
Gets the application attribute for the given key |
public static boolean getBoolean(String key,
boolean def) {
return ri.getBoolean( key, def );
}
Boolean property accessor method to hide the configuration implementation. |
public static ExtendedProperties getConfiguration() {
return ri.getConfiguration();
}
Return the velocity runtime configuration object. |
public static ContentResource getContent(String name) throws Exception, ResourceNotFoundException, ParseErrorException {
return ri.getContent( name );
}
Returns a static content resource from the
resource manager. Uses the current value
if INPUT_ENCODING as the character encoding. |
public static ContentResource getContent(String name,
String encoding) throws Exception, ResourceNotFoundException, ParseErrorException {
return ri.getContent( name, encoding );
}
Returns a static content resource from the
resource manager. |
public EventCartridge getEventCartridge() {
return ri.getApplicationEventCartridge();
}
Returns the event handlers for the application. |
public static int getInt(String key) {
return ri.getInt( key );
}
Int property accessor method to hide the configuration implementation. |
public static int getInt(String key,
int defaultValue) {
return ri.getInt( key, defaultValue );
}
Int property accessor method to hide the configuration implementation. |
public static Introspector getIntrospector() {
return ri.getIntrospector();
}
Return the Introspector for this RuntimeInstance |
public static String getLoaderNameForResource(String resourceName) {
return ri.getLoaderNameForResource( 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. |
public static Log getLog() {
return ri.getLog();
}
Returns a convenient Log instance that wraps the current LogChute. |
public static Object getProperty(String key) {
return ri.getProperty( 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. |
public static RuntimeInstance getRuntimeInstance() {
return ri;
} Deprecated! Use - getRuntimeServices() instead.
|
public static RuntimeServices getRuntimeServices() {
return ri;
}
Returns the RuntimeServices Instance used by this wrapper. |
public static String getString(String key) {
return ri.getString( key );
}
String property accessor method to hide the configuration implementation |
public static String getString(String key,
String defaultValue) {
return ri.getString( key, defaultValue );
}
String property accessor method with default to hide the
configuration implementation. |
public static Template getTemplate(String name) throws Exception, ResourceNotFoundException, ParseErrorException {
return ri.getTemplate( 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" |
public static Template getTemplate(String name,
String encoding) throws Exception, ResourceNotFoundException, ParseErrorException {
return ri.getTemplate( name, encoding );
}
Returns a Template from the resource manager |
public static Uberspect getUberspect() {
return ri.getUberspect();
}
Returns the Uberspect object for this Instance. |
public static Directive getVelocimacro(String vmName,
String templateName) {
return ri.getVelocimacro( vmName, templateName );
}
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro. |
public static void info(Object message) {
getLog().info(message);
} Deprecated! Use - getLog() and call info() on it.
|
public static synchronized void init() throws Exception {
ri.init();
}
This is the primary initialization method in the Velocity
Runtime. The systems that are setup/initialized here are
as follows:
- Logging System
- ResourceManager
- Event Handlers
- Parser Pool
- Global Cache
- Static Content Include System
- Velocimacro System
|
public static void init(Properties p) throws Exception {
ri.init(p);
}
Initialize the Velocity Runtime with a Properties
object. |
public static void init(String configurationFile) throws Exception {
ri.init( configurationFile );
}
Initialize the Velocity Runtime with the name of
ExtendedProperties object. |
public static boolean isInitialized() {
return ri.isInitialized();
}
Returns true if the RuntimeInstance has been successfully initialized. |
public static boolean isVelocimacro(String vmName,
String templateName) {
return ri.isVelocimacro( vmName, templateName );
}
Checks to see if a VM exists |
public static SimpleNode parse(Reader reader,
String templateName) throws ParseException {
return ri.parse( reader, 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. |
public static SimpleNode parse(Reader reader,
String templateName,
boolean dumpNamespace) throws ParseException {
return ri.parse( reader, templateName, dumpNamespace );
}
Parse the input and return the root of the AST node structure. |
public static void setConfiguration(ExtendedProperties configuration) {
ri.setConfiguration( 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. |
public static void setProperty(String key,
Object value) {
ri.setProperty( key, value );
}
Allows an external system to set a property in
the Velocity Runtime. |
public static void warn(Object message) {
getLog().warn(message);
} Deprecated! Use - getLog() and call warn() on it.
|