Class Summary |
RuntimeInstance
|
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.
-----------------------------------------------------------------------
*
|
RuntimeSingleton
|
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.
-----------------------------------------------------------------------
*
|
VelocimacroFactory
|
VelocimacroFactory.java
*
manages the set of VMs in a running Velocity engine.
*
|
VelocimacroManager
|
Manages VMs in namespaces. Currently, two namespace modes are
supported:
*
flat - all allowable VMs are in the global namespacelocal - inline VMs are added to it's own template namespace
*
Thanks to Jose Alberto Fernandez
for some ideas incorporated here.
*
|
VelocimacroManager.MacroEntry
|
wrapper class for holding VM information
|