org.apache.velocity.app
public class Velocity extends java.lang.Object implements RuntimeConstants
COUNTER_INITIAL_VALUE, COUNTER_NAME, DEBUG_PREFIX, DEFAULT_RUNTIME_DIRECTIVES, DEFAULT_RUNTIME_PROPERTIES, ENCODING_DEFAULT, ERROR_PREFIX, ERRORMSG_END, ERRORMSG_START, FILE_RESOURCE_LOADER_CACHE, FILE_RESOURCE_LOADER_PATH, INFO_PREFIX, INPUT_ENCODING, INTERPOLATE_STRINGLITERALS, LOGSYSTEM_LOG4J_EMAIL_BUFFER_SIZE, LOGSYSTEM_LOG4J_EMAIL_FROM, LOGSYSTEM_LOG4J_EMAIL_SERVER, LOGSYSTEM_LOG4J_EMAIL_SUBJECT, LOGSYSTEM_LOG4J_EMAIL_TO, LOGSYSTEM_LOG4J_FILE_BACKUPS, LOGSYSTEM_LOG4J_FILE_SIZE, LOGSYSTEM_LOG4J_PATTERN, LOGSYSTEM_LOG4J_REMOTE_HOST, LOGSYSTEM_LOG4J_REMOTE_PORT, LOGSYSTEM_LOG4J_SYSLOGD_FACILITY, LOGSYSTEM_LOG4J_SYSLOGD_HOST, NUMBER_OF_PARSERS, OUTPUT_ENCODING, PARSE_DIRECTIVE_MAXDEPTH, PARSER_POOL_SIZE, RESOURCE_LOADER, RESOURCE_MANAGER_CACHE_CLASS, RESOURCE_MANAGER_CLASS, RESOURCE_MANAGER_LOGWHENFOUND, RUNTIME_LOG, RUNTIME_LOG_ERROR_STACKTRACE, RUNTIME_LOG_INFO_STACKTRACE, RUNTIME_LOG_LOGSYSTEM, RUNTIME_LOG_LOGSYSTEM_CLASS, RUNTIME_LOG_REFERENCE_LOG_INVALID, RUNTIME_LOG_WARN_STACKTRACE, UBERSPECT_CLASSNAME, UNKNOWN_PREFIX, VM_CONTEXT_LOCALSCOPE, VM_LIBRARY, VM_LIBRARY_AUTORELOAD, VM_MESSAGES_ON, VM_PERM_ALLOW_INLINE, VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL, VM_PERM_INLINE_LOCAL, WARN_PREFIX
Constructor and Description |
---|
Velocity() |
Modifier and Type | Method and Description |
---|---|
static void |
addProperty(java.lang.String key,
java.lang.Object value)
Add a Velocity Runtime property.
|
static void |
clearProperty(java.lang.String key)
Clear a Velocity Runtime property.
|
static void |
debug(java.lang.Object message)
Log a debug message.
|
static void |
error(java.lang.Object message)
Log an error message.
|
static boolean |
evaluate(Context context,
java.io.Writer writer,
java.lang.String logTag,
java.io.InputStream instream)
|
static boolean |
evaluate(Context context,
java.io.Writer writer,
java.lang.String logTag,
java.io.Reader reader)
Renders the input reader using the context into the output writer.
|
static boolean |
evaluate(Context context,
java.io.Writer out,
java.lang.String logTag,
java.lang.String instring)
renders the input string using the context into the output writer.
|
static java.lang.Object |
getProperty(java.lang.String key)
Get a Velocity Runtime property.
|
static Template |
getTemplate(java.lang.String name)
Returns a
Template from the Velocity
resource management system. |
static Template |
getTemplate(java.lang.String name,
java.lang.String encoding)
Returns a
Template from the Velocity
resource management system. |
static void |
info(java.lang.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(java.util.Properties p)
initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object
|
static void |
init(java.lang.String propsFilename)
initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg
|
static boolean |
invokeVelocimacro(java.lang.String vmName,
java.lang.String logTag,
java.lang.String[] params,
Context context,
java.io.Writer writer)
Invokes a currently registered Velocimacro with the parms provided
and places the rendered stream into the writer.
|
static boolean |
mergeTemplate(java.lang.String templateName,
Context context,
java.io.Writer writer)
|
static boolean |
mergeTemplate(java.lang.String templateName,
java.lang.String encoding,
Context context,
java.io.Writer writer)
merges a template and puts the rendered stream into the writer
|
static boolean |
resourceExists(java.lang.String resourceName)
Determines whether a resource is accessable via the
currently configured resource loaders.
|
static void |
setApplicationAttribute(java.lang.Object key,
java.lang.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)
Deprecated.
|
static void |
setExtendedProperties(org.apache.commons.collections.ExtendedProperties configuration)
Set an entire configuration at once.
|
static void |
setProperty(java.lang.String key,
java.lang.Object value)
Set a Velocity Runtime property.
|
static boolean |
templateExists(java.lang.String resourceName)
Deprecated.
Use resourceExists(String) instead.
|
static void |
warn(java.lang.Object message)
Log a warning message.
|
public static void init() throws java.lang.Exception
java.lang.Exception
public static void init(java.lang.String propsFilename) throws java.lang.Exception
propsFilename
- file containing properties to use to initialize
the Velocity runtimejava.lang.Exception
public static void init(java.util.Properties p) throws java.lang.Exception
p
- Proprties object containing initialization propertiesjava.lang.Exception
public static void setProperty(java.lang.String key, java.lang.Object value)
String
- keyObject
- valuepublic static void addProperty(java.lang.String key, java.lang.Object value)
String
- keyObject
- valuepublic static void clearProperty(java.lang.String key)
key
- of property to clearpublic static void setConfiguration(Configuration configuration)
setExtendedProperties( ExtendedProperties )
Configuration
- configurationpublic static void setExtendedProperties(org.apache.commons.collections.ExtendedProperties configuration)
ExtendedProperties
- configurationpublic static java.lang.Object getProperty(java.lang.String key)
key
- property to retrievepublic static boolean evaluate(Context context, java.io.Writer out, java.lang.String logTag, java.lang.String instring) throws ParseErrorException, MethodInvocationException, ResourceNotFoundException, java.io.IOException
context
- context to use in rendering input stringout
- Writer in which to render the outputlogTag
- string to be used as the template name for log
messages in case of errorinstring
- input string containing the VTL to be renderedParseErrorException
MethodInvocationException
ResourceNotFoundException
java.io.IOException
public static boolean evaluate(Context context, java.io.Writer writer, java.lang.String logTag, java.io.InputStream instream) throws ParseErrorException, MethodInvocationException, ResourceNotFoundException, java.io.IOException
context
- context to use in rendering input stringout
- Writer in which to render the outputlogTag
- string to be used as the template name for log messages
in case of errorinstream
- input stream containing the VTL to be renderedParseErrorException
MethodInvocationException
ResourceNotFoundException
java.io.IOException
public static boolean evaluate(Context context, java.io.Writer writer, java.lang.String logTag, java.io.Reader reader) throws ParseErrorException, MethodInvocationException, ResourceNotFoundException, java.io.IOException
context
- context to use in rendering input stringout
- Writer in which to render the outputlogTag
- string to be used as the template name for log messages
in case of errorreader
- Reader containing the VTL to be renderedParseErrorException
MethodInvocationException
ResourceNotFoundException
java.io.IOException
public static boolean invokeVelocimacro(java.lang.String vmName, java.lang.String logTag, java.lang.String[] params, Context context, java.io.Writer writer)
vmName
- name of Velocimacro to calllogTag
- string to be used for template name in case of errorparams[]
- 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 streampublic static boolean mergeTemplate(java.lang.String templateName, Context context, java.io.Writer writer) throws ResourceNotFoundException, ParseErrorException, MethodInvocationException, java.lang.Exception
mergeTemplate( String templateName, String encoding,
Context context, Writer writer )
templateName
- name of template to be used in mergecontext
- filled context to be used in mergewriter
- writer to write template intoResourceNotFoundException
ParseErrorException
MethodInvocationException
java.lang.Exception
public static boolean mergeTemplate(java.lang.String templateName, java.lang.String encoding, Context context, java.io.Writer writer) throws ResourceNotFoundException, ParseErrorException, MethodInvocationException, java.lang.Exception
templateName
- name of template to be used in mergeencoding
- encoding used in templatecontext
- filled context to be used in mergewriter
- writer to write template intoResourceNotFoundException
ParseErrorException
MethodInvocationException
java.lang.Exception
public static Template getTemplate(java.lang.String name) throws ResourceNotFoundException, ParseErrorException, java.lang.Exception
Template
from the Velocity
resource management system.name
- The file name of the desired template.ResourceNotFoundException
- if template not found
from any available source.ParseErrorException
- if template cannot be parsed due
to syntax (or other) error.java.lang.Exception
- if an error occurs in template initializationpublic static Template getTemplate(java.lang.String name, java.lang.String encoding) throws ResourceNotFoundException, ParseErrorException, java.lang.Exception
Template
from the Velocity
resource management system.name
- The file name of the desired template.encoding
- The character encoding to use for the template.ResourceNotFoundException
- if template not found
from any available source.ParseErrorException
- if template cannot be parsed due
to syntax (or other) error.java.lang.Exception
- if an error occurs in template initializationpublic static boolean resourceExists(java.lang.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.
resourceName
- The name of the resource to search for.public static void warn(java.lang.Object message)
Object
- message to logpublic static void info(java.lang.Object message)
Object
- message to logpublic static void error(java.lang.Object message)
Object
- message to logpublic static void debug(java.lang.Object message)
Object
- message to logpublic static void setApplicationAttribute(java.lang.Object key, java.lang.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. 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.
key
- object 'name' under which the object is storedvalue
- object to store under this keypublic static boolean templateExists(java.lang.String resourceName)
resourceExists(String)
Copyright ? 2002 Apache Software Foundation. All Rights Reserved.