org.apache.velocity.app
public class Velocity extends Object implements RuntimeConstants
Version: $Id: Velocity.java,v 1.30.4.1 2004/03/03 23:22:53 geirm Exp $
Method Summary | |
---|---|
static void | addProperty(String key, Object value)
Add a Velocity Runtime property.
|
static void | clearProperty(String key)
Clear a Velocity Runtime property.
|
static void | debug(Object message)
Log a debug message.
|
static void | error(Object message)
Log an error message.
|
static boolean | evaluate(Context context, Writer out, String logTag, String instring)
renders the input string using the context into the output writer.
|
static boolean | evaluate(Context context, Writer writer, String logTag, InputStream instream)
Renders the input stream using the context into the output writer.
|
static boolean | evaluate(Context context, Writer writer, String logTag, Reader reader)
Renders the input reader using the context into the output writer.
|
static Object | getProperty(String key)
Get a Velocity Runtime property.
|
static Template | getTemplate(String name)
Returns a Template from the Velocity
resource management system.
|
static Template | getTemplate(String name, String encoding)
Returns a Template from the Velocity
resource management system.
|
static void | info(Object message)
Log an info message.
|
static void | init()
initialize the Velocity runtime engine, using the default
properties of the Velocity distribution |
static void | init(String propsFilename)
initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg
|
static void | init(Properties p)
initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object
|
static 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.
|
static boolean | mergeTemplate(String templateName, Context context, Writer writer)
merges a template and puts the rendered stream into the writer
|
static boolean | mergeTemplate(String templateName, String encoding, Context context, Writer writer)
merges a template and puts the rendered stream into the writer
|
static boolean | resourceExists(String resourceName) Determines whether a resource is accessable via the currently configured resource loaders. Resource is the generic description of templates, static content, etc. Note that the current implementation will not change the state of the system in any real way - so this cannot be used to pre-load the resource cache, as the previous implementation did as a side-effect. |
static 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. |
static void | setConfiguration(Configuration configuration)
Set an entire configuration at once. |
static void | setExtendedProperties(ExtendedProperties configuration)
Set an entire configuration at once. |
static void | setProperty(String key, Object value)
Set a Velocity Runtime property.
|
static boolean | templateExists(String resourceName) |
static 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.
Deprecated: Use Velocity
merges a template and puts the rendered stream into the writerParameters: 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.
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
Determines whether a resource is accessable via the currently configured resource loaders. Resource is the generic description of templates, static content, etc.
Note that the current implementation will not change the state of the system in any real way - so this cannot be used to pre-load the resource cache, as the previous implementation did as a side-effect.
Parameters: resourceName The name of the resource to search for.
Returns: Whether the resource was located.
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
Deprecated: Use resourceExists(String) instead.
See Also: resourceExists
Parameters: Object message to log