org.apache.velocity.app
public class VelocityEngine extends Object implements RuntimeConstants
This class provides a separate new-able instance of the Velocity template engine. The alternative model for use is using the Velocity class which employs the singleton model.
Please ensure that you call one of the init() variants. This is critical for proper behavior.
Coming soon : Velocity will call the parameter-less init() at the first use of this class if the init() wasn't explicitly called. While this will ensure that Velocity functions, it almost certainly won't function in the way you intend, so please make sure to call init().
Version: $Id: VelocityEngine.java,v 1.6.4.1 2004/03/03 23:22:53 geirm Exp $
Field Summary | |
---|---|
RuntimeInstance | ri |
Method Summary | |
---|---|
void | addProperty(String key, Object value)
Add a Velocity Runtime property.
|
void | clearProperty(String key)
Clear a Velocity Runtime property.
|
void | debug(Object message)
Log a debug message.
|
void | error(Object message)
Log an error message.
|
boolean | evaluate(Context context, Writer out, String logTag, String instring)
renders the input string using the context into the output writer.
|
boolean | evaluate(Context context, Writer writer, String logTag, InputStream instream)
Renders the input stream using the context into the output writer.
|
boolean | evaluate(Context context, Writer writer, String logTag, Reader reader)
Renders the input reader using the context into the output writer.
|
Object | getProperty(String key)
Get a Velocity Runtime property.
|
Template | getTemplate(String name)
Returns a Template from the Velocity
resource management system.
|
Template | getTemplate(String name, String encoding)
Returns a Template from the Velocity
resource management system.
|
void | info(Object message)
Log an info message.
|
void | init()
initialize the Velocity runtime engine, using the default
properties of the Velocity distribution |
void | init(String propsFilename)
initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg
|
void | init(Properties p)
initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object
|
boolean | invokeVelocimacro(String vmName, String logTag, String[] params, Context context, Writer writer)
Invokes a currently registered Velocimacro with the parms provided
and places the rendered stream into the writer.
|
boolean | mergeTemplate(String templateName, Context context, Writer writer)
merges a template and puts the rendered stream into the writer
|
boolean | mergeTemplate(String templateName, String encoding, Context context, Writer writer)
merges a template and puts the rendered stream into the writer
|
void | setApplicationAttribute(Object key, Object value) Set the an ApplicationAttribue, which is an Object set by the application which is accessable from any component of the system that gets a RuntimeServices. |
void | setConfiguration(Configuration configuration)
Set an entire configuration at once. |
void | setExtendedProperties(ExtendedProperties configuration)
Set an entire configuration at once. |
void | setProperty(String key, Object value)
Set a Velocity Runtime property.
|
boolean | templateExists(String templateName)
Determines if a template is accessable via the currently
configured resource loaders.
|
void | warn(Object message)
Log a warning message.
|
Parameters: String key Object value
Parameters: key of property to clear
Parameters: Object message to log
Parameters: Object message to log
Parameters: context context to use in rendering input string out Writer in which to render the output logTag string to be used as the template name for log messages in case of error instring input string containing the VTL to be rendered
Returns: true if successful, false otherwise. If false, see Velocity runtime log
Parameters: context context to use in rendering input string out Writer in which to render the output logTag string to be used as the template name for log messages in case of error instream input stream containing the VTL to be rendered
Returns: true if successful, false otherwise. If false, see Velocity runtime log
Parameters: context context to use in rendering input string out Writer in which to render the output logTag string to be used as the template name for log messages in case of error reader Reader containing the VTL to be rendered
Returns: true if successful, false otherwise. If false, see Velocity runtime log
Since: Velocity v1.1
Parameters: key property to retrieve
Returns: property value or null if the property not currently set
Template
from the Velocity
resource management system.
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 Velocity
resource management system.
Parameters: name The file name of the desired template. encoding The character encoding to use for 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
Since: Velocity v1.1
Parameters: Object message to log
Parameters: propsFilename file containing properties to use to initialize the Velocity runtime
Parameters: p Proprties object containing initialization properties
Parameters: vmName name of Velocimacro to call logTag string to be used for template name in case of error params[] args used to invoke Velocimacro. In context key format : eg "foo","bar" (rather than "$foo","$bar") context Context object containing data/objects used for rendering. writer Writer for output stream
Returns: true if Velocimacro exists and successfully invoked, false otherwise.
Parameters: templateName name of template to be used in merge context filled context to be used in merge writer writer to write template into
Returns: true if successful, false otherwise. Errors logged to velocity log. * @deprecated Use VelocityEngine
Parameters: templateName name of template to be used in merge encoding encoding used in template context filled context to be used in merge writer writer to write template into
Returns: true if successful, false otherwise. Errors logged to velocity log
Since: Velocity v1.1
Set the an ApplicationAttribue, which is an Object set by the application which is accessable from any component of the system that gets a RuntimeServices. This allows communication between the application environment and custom pluggable components of the Velocity engine, such as loaders and loggers.
Note that there is no enfocement or rules for the key used - it is up to the application developer. However, to help make the intermixing of components possible, using the target Class name (e.g. com.foo.bar ) as the key might help avoid collision.
Parameters: key object 'name' under which the object is stored value object to store under this key
Parameters: Configuration configuration
Parameters: ExtendedProperties configuration
Parameters: String key Object value
Parameters: templateName name of the temlpate to search for
Returns: true if found, false otherwise
Parameters: Object message to log