This class is the abstract base class for all conventional
Velocity Context implementations.
Chaining constructor accepts a Context argument.
Abstract class that is used to execute an arbitrary
method that is in introspected.
Add a method to a list of methods by name.
Used to convert raw characters to their escaped version
when these raw version cannot be used as part of an ASCII
string literal.
Copy all the entries into the entryDirectory
It will overwrite any duplicate keys.
Replaces unprintable characters by their espaced (or unicode escaped)
equivalents in the given string
Adds an event handler(s) to the Cartridge.
Add a file to the filename stack
adds a namespace to the namespaces
controls if new VMs can be added.
Add an Object to methodize
Add the Name of the class to methodize
Add a property to the configuration.
Add a property to the configuration.
Add a property to the configuration.
Add a property to the configuration.
Add a property to the configuration.
Add a Velocity Runtime property.
Add a Velocity Runtime property.
Sets a string property w/o checking for commas - used
internally when a property has been broken up into
strings that could contain escaped commas to prevent
the inadvertant vectorization.
adds a macro to the factory.
Adds a VM definition to the cache.
Used to put VMProxyArgs into this context.
Method to adjust line and column numbers for the start of a token.
Creates a new Vector and walks the Element tree.
Check to see if all the string objects passed
in are empty.
Alternates to the next in the list.
simple distinguishable exception, used when
we run across ambiguous overloading
A JDOM Element
that is tailored for Anakia needs.
This will create an AnakiaElement
in no
Namespace
.
This will create a new AnakiaElement
with the supplied (local) name, and define
the Namespace
to be used.
This will create a new AnakiaElement
with
the supplied (local) name, and specifies the URI
of the Namespace
the Element
should be in, resulting it being unprefixed (in the default
namespace).
This will create a new AnakiaElement
with
the supplied (local) name, and specifies the prefix and URI
of the Namespace
the Element
should be in.
A customized JDOMFactory for Anakia that produces
AnakiaElement
instances instead of ordinary JDOM
Element
instances.
The purpose of this Ant Task is to allow you to use
Velocity as an XML transformation tool like XSLT is.
Constructor creates the SAXBuilder.
Apply an XPath to a JDOM Document
Apply an XPath to a JDOM Element
Apply an XPath to a nodeset
Map containing VM arg to instance-use reference
Passed in with CTOR
Container to hold the 'key' part of
get(key).
An Iterator wrapper for an Object[].
Creates a new iterator instance for the specified array.
This will produce a List of Hashtables, each
hashtable contains the intialization info for
a particular resource loader.
Handles integer addition of nodes
Please look at the Parser.jjt file which is
what controls the generation of this class.
Please look at the Parser.jjt file which is
what controls the generation of this class.
Represents all comments...
This class is responsible for handling the pluggable
directives in VTL.
Handles integer division of nodes
Please look at the Parser.jjt file which is
what controls the generation of this class.
This class is responsible for handling the ElseIf VTL control statement.
This class is responsible for handling the Else VTL control statement.
Handles the equivalence operator
==
This operator requires that the LHS and RHS are both of the
same Class. This class is responsible for handling Escapes
in VTL.
This class is responsible for handling EscapedDirectives
in VTL.
ASTIdentifier.java
Method support for identifiers : $foo
mainly used by ASTRefrence
Introspection is now moved to 'just in time' or at render / execution
time.
Please look at the Parser.jjt file which is
what controls the generation of this class.
handles the range 'operator' [ n ..
ASTMethod.java
Method support for references : $foo.method()
NOTE :
introspection is now done at render time.
Handles integer modulus division
Please look at the Parser.jjt file which is
what controls the generation of this class.
Handles integer multiplication
Please look at the Parser.jjt file which is
what controls the generation of this class.
Please look at the Parser.jjt file which is
what controls the generation of this class.
This class is responsible for handling the references in
VTL ($foo).
Node for the #set directive
ASTStringLiteral support.
Handles integer subtraction of nodes (in #set() )
Please look at the Parser.jjt file which is
what controls the generation of this class.
Attached the EventCartridge to the context
Final because not something one should mess with lightly :)
A special subclass of XMLOutputter that will be used to output
Attribute nodes.
determines if the libraries are auto-loaded
when they change
Implementation of a Avalon logger.
Cache storage, assumed to be thread-safe.
Holds the qualified class names for the classes
we hold in the classMethodMaps hash
define a public string so that it can be looked for
if interested
the reference we are proxying for
determines if a given macro/namespace (name, source) combo is allowed
to be added
Capitalize the first letter but leave the rest as they are.
carr - field in class org.apache.velocity.runtime.parser.node.
ASTComment This interface describes a character stream that maintains line and
column number positions of the characters.
Chooses the output character encoding to be used as the value
for the "charset=" portion of the HTTP Content-Type header (and
thus returned by response.getCharacterEncoding()
).
Chop i characters off the end of a string.
Chop i characters off the end of a string.
Hold the class objects by field name
A cache of introspection information for a specific class instance.
Holds the method maps for the classes we know about, keyed by
Class object.
Class name for this loader, for logging/debuggin
purposes.
ClasspathResourceLoader is a simple loader that will load
templates from the classpath.
clazz - field in class org.apache.velocity.util.introspection.
ClassMap Class passed into the constructor used to as
the basis for the Method map.
A hook method called at the end of
execute()
which can
be overridden to perform any necessary cleanup activities (such
as the release of database connections, etc.).
Discard the output buffer.
Clears the classmap and classname
caches, and logs that we did so
Clears the classmap and classname
caches
Clear a property in the configuration.
Clear the values pertaining to a particular
property.
Clear the values pertaining to a particular
property.
Clear the values pertaining to a particular
property.
Clear the values pertaining to a particular
property.
Clear a Velocity Runtime property.
Clear a Velocity Runtime property.
Clears all state variables, resets to
start values, clears stateStack.
Returns a NodeList that contains the same nodes as this node list.
Clones this context object.
Closes connection to the datasource
Closes a Jar file and set its URLConnection
to null.
Remove/collapse multiple newline characters.
Remove/collapse multiple spaces.
column - field in class org.apache.velocity.util.introspection.
Info Combines an existing Hashtable with this Hashtable.
This initialization is used by all resource
loaders and must be called to set up common
properties shared by all resource loaders
The start of a velocity template compiler.
Concatenates a list of objects as a String.
This class extends normal Java properties by adding the possibility
to use the same key many times concatenating the value strings
instead of overwriting them.
Object that houses the configuration options for
the velocity runtime.
Creates an empty extended properties object.
Creates and loads the extended properties from the specified
file.
Creates and loads the extended properties from the specified
file.
Configures the logging to email
Configures the logging to a file.
Configures the logging to a remote server
Configures the logging to syslogd
conn - field in class org.apache.velocity.runtime.resource.loader.
JarHolder by default, we are dynamic.
Indicates whether the specified key is in the context.
Indicates whether the specified key is in the context.
Indicates whether the specified key is in the context.
The HTTP content type context key.
This class represent a general text resource that may have been
retrieved from any number of possible sources.
Default empty constructor
Context used during traversal
the user data Context that we are wrapping
Interface describing the application data context.
Storage for key/value pairs.
These are properties that are fed into the
initial context from a properties file.
our identity in the current context
Context used for generating the texen output.
This is the control template that governs the output.
Iterate through the set of find/replace regexes
that will convert a given WM template to a VM template
Simple extension conversion of .wm to .vm
Convert a standard properties class into a configuration
class.
Apply find/replace regexes to our WM template
Initial counter value in #foreach directives.
Initial counter value in #foreach directives.
What value to start the loop counter at.
The name of the variable to use when placing
the counter value into the context.
Creates a class map for specific class and registers it in the
cache.
Returns a context suitable to pass to the handleRequest() method
Default implementation will create a VelocityContext object,
put the HttpServletRequest and HttpServletResponse
into the context accessable via the keys VelocityServlet.REQUEST and
VelocityServlet.RESPONSE, respectively.
Creates a new logging system or returns an existing one
specified by the application.
Returns a JavaCC generated Parser.
Returns a JavaCC generated Parser.
ctext - field in class org.apache.velocity.runtime.parser.node.
ASTEscape ctext - field in class org.apache.velocity.runtime.parser.node.
ASTText index of previous to next
free slot
Current resource - used for carrying encoding and other
information down into the rendering process
Name of current template we are parsing.
This is the last token that has been consumed successfully.
The reference name used to access each
of the elements in the list object.
Character encoding of this resource
beginLine and beginColumn describe the position of the first character
of this token; endLine and endColumn describe the position of the
last character of this token.
endLine - field in class org.apache.velocity.runtime.parser.
Token beginLine and beginColumn describe the position of the first character
of this token; endLine and endColumn describe the position of the
last character of this token.
create directories as needed
Maps entries to the parent JAR File
Key = the entry *excluding* plain directories
Value = the JAR URL
The enumeration to iterate.
returns an Iterator of Keys in the cache
An Iterator wrapper for an Enumeration.
Creates a new iteratorwrapper instance for the specified
Enumeration.
The end of line string for this machine.
Line separator for the OS we are operating on.
Length of the line separator.
Tests for equality with another object.
This message fragment (telling users to consult the log or
invoke ant with the -debug flag) is appended to rethrown
exception messages.
Invoked when there is an error thrown in any part of doRequest() processing.
Prefix for error messages.
Indicates the reason why the exception is thrown.
Ending tag for error messages triggered by passing
a parameter not allowed in the #include directive.
Starting tag for error messages triggered by passing
a parameter not allowed in the #include directive.
This class is for escaping CDATA sections.
Used to catch and process escape sequences in grammatical constructs
as escapes outside of VTL are just characters.
used to separate the notion of a valid directive that has been
escaped, versus something that looks like a directive and
is just schmoo.
Produces a processed output for an escaped control or
pluggable directive
Renders the input stream using the context into the output writer.
Renders the input stream using the context into the output writer.
Renders the input reader using the context into the output writer.
Renders the input reader using the context into the output writer.
renders the input string using the context into the output writer.
renders the input string using the context into the output writer.
logical and :
null && right = false
left && null = false
null && null = false
An ASTElseStatement is true if the expression
it contains evaluates to true.
An ASTElseStatement always evaluates to
true.
Calculates the value of the logical expression
arg1 == arg2
All class types are supported.
the logical or :
the rule :
left || null -> left
null || right -> right
null || null -> false
left || right -> left || right
Computes boolean value of this reference
Returns the actual value of reference return type
boolean, and 'true' if value is not null
EventCartridge we are to carry.
'Package' of event handlers...
Base interface for all event handlers
Main body of the application
Execute the input script with Velocity
Execute method against context.
Execute method against context.
Execute method against context.
invokes the method on the object passed in
gets an Object that 'is' the value of the reference
Each entry in this array is an array of integers.
the default output extension is .html
Gets the path segment of the full path to a file (i.e.
in the event our type is switched - we don't care really what it is
A text/code generator class
Create a new Generator object with a given property
set.
Create a new generator object with properties loaded from
a file.
Get an object from the pool, null if the pool is empty.
retrieves a Resource from the
cache
Gets the value corresponding to the provided key from the context.
Gets the value corresponding to the provided key from the context.
Accessor method to get the fields by name.
Gets the value corresponding to the provided key from the context.
Return a list of methods with the same name.
Impl of the Context.gut() method.
gets a new living VelocimacroProxy object by the
name / source template duple
Retrieves public methods for a class.
Recursively finds a match for each method, starting with the class, and then
searching the superclass and interfaces.
Returns all methods that are applicable to actual argument types.
Return the specified applcation attribute.
creates an array containing the literal
strings in the macro arguement
gets the args to the VM from the instance-use AST
Returns an array of the literal rep of the AST
This returns the complete set of attributes for this element, as a
NodeList
of Attribute
objects in no particular
order, or an empty list if there are none.
get the switch for automatic reloading of
global library-based VMs
Returns the base context that we are
wrapping.
returns the base full context impl
returns the base full context impl
Returns the column number of the first character for current token (being
matched after the last call to BeginTOken).
Returns the column number of the first character for current token (being
matched after the last call to BeginTOken).
Returns the line number of the first character for current token (being
matched after the last call to BeginTOken).
Returns the line number of the first character for current token (being
matched after the last call to BeginTOken).
Get a boolean associated with the given configuration key.
Get a boolean associated with the given configuration key.
Boolean property accessor method to hide the configuration implementation.
Boolean property accessor method to hide the configuration implementation.
Boolean property accessor method to hide the configuration implementation.
Boolean property accessor method to hide the configuration implementation.
This method returns the size of the buffer used by the JspWriter.
Get a byte associated with the given configuration key.
Get a byte associated with the given configuration key.
returns innerContext if one is chained
This returns a NodeList
of all the child elements
nested directly (one level deep) within this element, as
Element
objects.
This returns a NodeList
of all the child elements
nested directly (one level deep) within this element with the given
local name and belonging to no namespace, returned as
Element
objects.
This returns a NodeList
of all the child elements
nested directly (one level deep) within this element with the given
local name and belonging to the given Namespace, returned as
Element
objects.
Return the class name of this resource Loader
Returns the column position of the character last read.
Return the velocity runtime configuration object.
Return the velocity runtime configuration object.
Return the velocity runtime configuration object.
Return the velocity runtime configuration object.
This returns the full content of the element as a NodeList which
may contain objects of type String
, Element
,
Comment
, ProcessingInstruction
,
CDATA
, and EntityRef
.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Returns a static content resource from the
resource manager.
Create a new context and fill it with the elements of the
objs Hashtable.
Get the context properties that will be
fed into the initial context be the
generating process starts.
Get the control template for the
generating process.
temporary fix to enable #include() to figure out
current encoding.
temporary fix to enable #include() to figure out
current encoding.
temporary fix to enable #include() to figure out
current encoding.
temporary fix to enable #include() to figure out
current encoding.
get the current template name
get the current template name
get the current template name
get the current template name
Get arbitrary data object that might be used
by the resource.
This method gets a Directive from the directives Hashtable
Gets the name of this directive.
Get a double associated with the given configuration key.
Get a double associated with the given configuration key.
get the encoding of this resource
for example, "ISO-8859-1"
Returns the column number of the last character for current token (being
matched after the last call to BeginTOken).
Returns the column number of the last character for current token (being
matched after the last call to BeginTOken).
Returns the line number of the last character for current token (being
matched after the last call to BeginTOken).
Returns the line number of the last character for current token (being
matched after the last call to BeginTOken).
Executor that simply tries to execute a get(key)
operation.
Routine intended for deprecation period only
as we switch from using the Configuration
class in Velocity to the Jakarta Commons
ExtendedProperties
Do not use this for general use.
Get a float associated with the given configuration key.
Get a float associated with the given configuration key.
Returns a string made up of characters from the marked token beginning
to the current buffer position.
Returns a string made up of characters from the marked token beginning
to the current buffer position.
Gets the property value for including other properties files.
getInfo() - method in class org.apache.velocity.runtime.parser.node.
Node Decides the encoding used during input processing of this
directive.
Create a new generator object with default properties.
The purpose of this method is to get the configuration resource
with the given name as an integer.
Int property accessor method to hide the configuration implementation.
Int property accessor method to hide the configuration implementation.
Int property accessor method to hide the configuration implementation.
Int property accessor method to hide the configuration implementation.
The purpose of this method is to get the configuration resource
with the given name as an integer, or a default value.
Int property accessor method to hide the configuration implementation.
Int property accessor method to hide the configuration implementation.
Int property accessor method to hide the configuration implementation.
Int property accessor method to hide the configuration implementation.
Get a int associated with the given configuration key.
Get a int associated with the given configuration key.
Get a int associated with the given configuration key.
returns the user data context that
we are wrapping
returns the wrapped user context
return the inner / user context
Return the Introspector for this instance
Returns the configured method introspection/reflection
implemenation.
Return the Introspector for this RuntimeInstance
To support iteratives - #foreach()
To support iteratives - #foreach()
Get all the keys for the values in the context
Get the list of the keys contained in the configuration
repository.
Get all the keys for the values in the context
Get all the keys for the values in the context
Get the list of the keys contained in the configuration
repository that match the specified prefix.
Return the lastModifed time of this
template.
Get the last modified time of the InputStream source
that was used to create the template.
Get the last modified time of the InputStream source
that was used to create the template.
returns the ASTReference that is the LHS of the set statememt
Returns the line number of the character last read.
getLine() - method in class org.apache.velocity.util.introspection.
Info getLine() - method in class org.apache.velocity.runtime.parser.node.
Node Retrieves the underlying list used to store the nodes.
Gets the loader specified in the configuration file.
Determines is a template exists, and returns name of the loader that
provides it.
Determines is a template exists, and returns name of the loader that
provides it.
Determines is a template exists, and returns name of the loader that
provides it.
Determines is a template exists, and returns name of the loader that
provides it.
Determines is a template exists, and returns name of the loader that
provides it.
Determines is a template exists, and returns name of the loader that
provides it.
Get a long associated with the given configuration key.
Get a long associated with the given configuration key.
Return the size of the pool
This method has the standard behavior when this object has been
created using the standard constructors.
You can also modify the body of this method to customize your error messages.
Gets the method defined by name
and
params
for the Class c
.
Gets the method defined by name
and
params
for the Class c
.
Returns a general method, corresponding to $foo.bar( $woogie )
Returns the name of the method that threw the
exception
returns the method name used to set this 'property'
returns the method name used
returns the method name used to return this 'property'
returns the method name used to set this 'property'
Get the interval at which the InputStream source
should be checked for modifications.
Return the name of this directive
Return name of this directive.
Return name of this directive.
Return name of this directive.
getName() - method in class org.apache.velocity.runtime.directive.
Macro Return name of this directive.
getName() - method in class org.apache.velocity.runtime.directive.
Parse Return name of this directive.
Get the name of this template.
Return name of this Velocimacro.
returns the hash for the specified namespace.
returns the hash for the specified namespace, and if it doesn't exist
will create a new one and add it to the namespaces
returns the number of ars needed for this VM
returns the value of the reference.
Get the output directory.
Get the output file for the
generation process.
Get the output path for the generated
output.
Return a package name as a relative path name
Get a list of properties associated with the given
configuration key.
Get a list of properties associated with the given
configuration key.
Gets a property from the configuration.
Allows an external caller to get a property.
Allows an external caller to get a property.
Allows an external caller to get a property.
Allows an external caller to get a property.
Get a Velocity Runtime property.
Get a Velocity Runtime property.
Property getter - returns VelPropertyGet appropos for #set($foo = $bar.woogie)
Property setter - returns VelPropertySet appropos for #set($foo.bar = "geir")
Looks up the method with specified name and signature in the first public
superclass or implemented interface of the class.
For a given method, retrieves its publicly accessible counterpart.
Retrieves the name of the reference that caused the
exception
Hacky method to figure out the relative path
that we are currently in.
Return the template loader that pulled
in the template stream
Get an InputStream so that the Runtime can build a
template with it.
Get an InputStream so that the Runtime can build a
template with it.
Get an InputStream so that the Runtime can build a
template with it.
Get an InputStream so that the Runtime can build a
template with it.
Get the InputStream that the Runtime will parse
to create a template.
returns the return type of the method invoked
returns the RHS Node of the set statement
Returns the 'root string', the reference key
Get a short associated with the given configuration key.
Get a short associated with the given configuration key.
Get a string associated with the given configuration key.
String property accessor method to hide the configuration implementation
String property accessor method to hide the configuration implementation
String property accessor method to hide the configuration implementation
String property accessor method to hide the configuration implementation
Get a string associated with the given configuration key.
String property accessor method with default to hide the
configuration implementation.
String property accessor method with default to hide the
configuration implementation.
String property accessor method with default to hide the
configuration implementation.
String property accessor method with default to hide the
configuration implementation.
Get an array of strings associated with the given configuration
key.
Returns an array of characters that make up the suffix of length 'len' for
the currently matched token.
Returns an array of characters that make up the suffix of length 'len' for
the currently matched token.
Returns a Template
from the resource manager.
Returns a Template
from the resource manager.
Returns a Template
from the resource manager.
Returns a Template
from the resource manager.
Returns a Template
from the Velocity
resource management system.
Returns a Template
from the Velocity
resource management system.
Retrieves the requested template.
Returns a template, based on encoding and path.
Returns a Template
from the resource manager
Returns a Template
from the resource manager
Returns a Template
from the resource manager
Returns a Template
from the resource manager
Returns a Template
from the Velocity
resource management system.
Returns a Template
from the Velocity
resource management system.
Retrieves the requested template with the specified
character encoding.
Returns the template name stack in form of an array.
get the current template name stack
Returns the template name stack in form of an array.
Returns the template name stack in form of an array.
Get the path where Velocity will look
for templates using the file template
loader.
Utility method to format time.
Get the directive type BLOCK/LINE
Return type of this directive.
Return type of this directive.
Return type of this directive.
getType() - method in class org.apache.velocity.runtime.directive.
Macro Return type of this directive.
getType() - method in class org.apache.velocity.runtime.parser.node.
Node getType() - method in class org.apache.velocity.runtime.directive.
Parse Return type of this directive.
Velocimacros are always LINE
type directives.
Returns the configured class introspection/reflection
implemenation.
Get a Vector of strings associated with the given configuration
key.
Get a Vector of strings associated with the given configuration
key.
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
actual factory : creates a Directive that will
behave correctly wrt getting the framework to
dig out the correct # of args
returns the wrapped Throwable that caused this
MethodInvocationException to be thrown
Returns a writer, based on encoding and path.
Returns an XPath object representing the requested XPath expression.
Object implementing ResourceCache to
be our resource manager's Resource cache.
returns an IntrospectionCache Data (@see IntrospectionCacheData)
object if exists for the key
returns an IntrospectionCache Data (@see IntrospectionCacheData)
object if exists for the key
returns an IntrospectionCache Data (@see IntrospectionCacheData)
object if exists for the key
returns an IntrospectionCache Data (@see IntrospectionCacheData)
object if exists for the key
places an IntrospectionCache Data (@see IntrospectionCacheData)
element in the cache for specified key
places an IntrospectionCache Data (@see IntrospectionCacheData)
element in the cache for specified key
places an IntrospectionCache Data (@see IntrospectionCacheData)
element in the cache for specified key
places an IntrospectionCache Data (@see IntrospectionCacheData)
element in the cache for specified key
id - field in class org.apache.velocity.runtime.parser.node.
SimpleNode This method corresponds to variable
references in Velocity templates.
The InternalEventContext that we are wrapping.
image - field in class org.apache.velocity.runtime.parser.
Token The string image of the token.
This is the name of the property that can point to other
properties file for including other properties files.
Pluggable directive that handles the #include() statement in VTL.
Indent child nodes to help visually identify
the structure of the AST.
Info - class org.apache.velocity.util.introspection.
Info Little class to carry in info such as template name, line and column
for information error reporting from the uberspector implementations
info - field in class org.apache.velocity.runtime.parser.node.
SimpleNode Info() - constructor for class org.apache.velocity.util.introspection.
Info Prefix for info messages.
init() - method in class org.apache.velocity.runtime.resource.loader.
JarHolder init() - static method in class org.apache.velocity.runtime.
Runtime This is the primary initialization method in the Velocity
Runtime.
Initializer - will be called before use
init - does nothing - we need to have setRuntimeLogger
called before getting our introspector, as the default
vel introspector depends upon it.
initialize the Velocity runtime engine, using the default
properties of the Velocity distribution
initialize the Velocity runtime engine, using the default
properties of the Velocity distribution
This is abstract in the base class, so we need it
Initialize the template loader with a
a resources class.
Called by Velocity to initialize the loader
Initialize the template loader with a
a resources class.
We need to make sure we catch any of the dreaded MORE tokens.
simple init - don't do anything that is context specific.
simple init - init our subtree and get what we can from
the AST
Initialization method - doesn't do much but do the object
creation.
init : we don't have to do much.
Private initializer method that sets up the generic
resources.
How this directive is to be initialized.
simple init - init the tree and get the elementKey from
the AST
simple init - init the tree and get the elementKey from
the AST
Store the literal rendition of a node using
the Node.literal().
The major meat of VelocimacroProxy, init() checks the # of arguments, patches the
macro body, renders the macro into an AST, and then inits the AST, so it is ready
for quick rendering.
Initialize the Velocity Runtime with a Properties
object.
Initialize the Velocity Runtime with a Properties
object.
Initialize the Velocity Runtime with a Properties
object.
Initialize the Velocity Runtime with a Properties
object.
initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object
initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object
Performs initialization of this servlet.
initializes the log system using the logfile argument
Initialize the Velocity Runtime with the name of
ExtendedProperties object.
Initialize the Velocity Runtime with the name of
ExtendedProperties object.
Initialize the Velocity Runtime with the name of
ExtendedProperties object.
Initialize the Velocity Runtime with the name of
ExtendedProperties object.
initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg
initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg
This is the string that is looked for when getInitParameter is
called (org.apache.velocity.properties
).
Creates a VelocityContext.
initializes the document.
initializes the ResourceCache.
Initialize the ResourceManager.
Initialize the ResourceManager.
Indicate whether the Runtime has been fully initialized.
To keep track of whether this template has been
initialized.
This methods initializes all the directives
that are used by the Velocity Runtime.
Gets the classname for the Uberspect introspection package and
instantiates an instance.
Initialize the Velocity logging system.
Initializes the Velocity parser pool.
Initialize Velocity properties, if the default
properties have not been laid down first then
do so.
initialize the factory - setup all permissions
load all global libraries.
Initializes the Velocity runtime, first calling
loadConfiguration(ServletConvig) to get a
java.util.Properties of configuration information
and then calling Velocity.init().
the chained Context if any
The character encoding for the templates.
Base class for directives which do input operations
(e.g.
This is the encoding for the input file(s)
(templates).
This is the encoding for the input file(s)
(templates).
Method that retrieves all public static fields
in the class we are methodizing.
The generator tools used for creating additional
output withing the control template.
supports the [n..m] vector generator for use in
the #foreach() to generate measured ranges w/o
needing explicit support from the app/servlet
Implement to determine if a key is in the storage.
determines if there is a value for the
given key
interface to bring all necessary internal and user contexts together.
This adapter class is the container for all context types for internal
use.
CTOR takes a Context and wraps it, delegating all 'data' calls
to it.
class to encapsulate the 'stuff' for internal operation of velocity.
Interface for event support.
Implement to return a value from the context storage.
retrieves value for key from internal
storage
Implement to return an object array of key
strings from your storage.
interface to encapsulate the 'stuff' for internal operation of velocity.
initializes the log system using the logfile argument
initializes the log system using the logfile argument
Implement to put a value into the context storage.
stores the value for key to internal
storage
I mplement to remove an item from your storage.
remove a key/value pair from the
internal storage
interface for internal context wrapping functionality
Utility method to interpolate context variables
into string literals.
Switch for the interpolation facility for string literals
cache for node/context specific introspection information
Holds information for node-local context data introspection
information.
This basic function of this class is to return a Method
object for a particular class given the name of a method
and the parameters to the method in the form of an Object[]
The first time the Introspector sees a
class it creates a class method map for the
class in question.
the default Velocity introspector
Recieves our RuntimeServices object
This basic function of this class is to return a Method
object for a particular class given the name of a method
and the parameters to the method in the form of an Object[]
The first time the Introspector sees a
class it creates a class method map for the
class in question.
Tried to change to an invalid lexical state.
invocation method - called when the 'get action' should be
preformed and a value returned
method used to set the value in the object
method used to set the value in the object
invocation method - called when the method invocationshould be
preformed and a value returned
Invokes a currently registered Velocimacro with the parms provided
and places the rendered stream into the writer.
Invokes a currently registered Velocimacro with the parms provided
and places the rendered stream into the writer.
Tell whether the executor is alive by looking
at the value of the method.
Returns true if the supplied method is applicable to actual
argument types.
This method indicates whether the JspWriter is autoFlushing.
specifies if this VelPropertySet is cacheable and able to be
reused for this class of object it was returned for
specifies if this VelMethod is cacheable and able to be
reused for this class of object it was returned for
specifies if this VelPropertyGet is cacheable and able to be
reused for this class of object it was returned for
specifies if this VelPropertySet is cacheable and able to be
reused for this class of object it was returned for
Does this loader want templates produced with it
cached in the Runtime.
The Runtime uses this to find out whether this
template loader wants the Runtime to cache
templates created with InputStreams provided
by this loader.
tells if arg we are poxying for is
dynamic or constant.
This method finds out of the directive exists in the directives
Hashtable.
Has this configuration been intialized.
Indicate to client code whether property
resources have been initialized or not.
Determines whether a type represented by a class object is
convertible to another type represented by a class object using a
method invocation conversion, treating object types of primitive
types as if they were primitive types (that is, a Boolean actual
parameter type matches boolean primitive formal type).
Returns a default value if the object passed is null.
Defaults to return false.
How to keep track of all the modified times
across the paths.
Given a template, check to see if the source of InputStream
has been modified.
Determines whether a type represented by a class object is
convertible to another type represented by a class object using a
method invocation conversion, without matching object and primitive
types.
Checks to see if a VM exists
Checks to see if a VM exists
Checks to see if a VM exists
Checks to see if a VM exists
Tells the world if a given directive string is a Velocimacro
This method has yet to be fully implemented
but will allow arbitrarily nested method
calls
Parse - class org.apache.velocity.runtime.directive.
Parse Pluggable directive that handles the #parse()
statement in VTL.
This was also added to allow parsers to be
re-usable.
Parse the input and return the root of
AST node structure.
Parse the input and return the root of
AST node structure.
Parse the input and return the root of
AST node structure.
Parse the input and return the root of
AST node structure.
Parse the input and return the root of the AST node structure.
Parse the input and return the root of the AST node structure.
Parse the input and return the root of the AST node structure.
Parse the input and return the root of the AST node structure.
Parse the control template and merge it with the control
context.
Parse an input and write the output to an output file.
Parse an input and write the output to an output file.
Parse an input and write the output to an output file.
Maximum recursion depth allowed for the #parse directive.
Exception for #parse() problems
Application-level exception thrown when a resource of any type
has a syntax or other error which prevents it from being parsed.
This exception is thrown when parse errors are encountered.
The following constructors are for use by you for whatever
purpose you can think of.
This constructor is used by the method "generateParseException"
in the generated parser.
This class is responsible for parsing a Velocity
template.
This constructor was added to allow the re-use of parsers.
The paths to search for templates.
The regexes to use for line by line substition.
remove the current template name from stack
remove the current template name from stack
remove the current template name from stack
remove the current template name from stack
Place useful objects into the initial context.
Populate the Map of direct hits.
The current position and size in the array.
Pull in static content and store it.
This method is what starts the whole parsing
process.
Perform any subsequent processing that might need
to be done by a resource.
gets the named resource as a stream, parses and inits
Process an XML file using Velocity
Used by Parser.java to process VMs withing the parsing process
processAndRegister() doesn't actually render the macro to the output
Processes the macro body into the internal representation used by the
VelocimacroProxy objects, and if not currently used, adds it
to the macro Factory
the projectFile= attribute
the File for the project.xml file
last modified of the project file if it exists
This class is used to read properties lines.
This class divides into tokens a property value.
A property utility class for the texen text/code generator
Usually this class is only used from a Velocity context.
Returned the value of object property when executed.
Default properties used by texen.
set the current template name on top of stack
set the current template name on top of stack
set the current template name on top of stack
set the current template name on top of stack
Add the object to the pool, silent nothing if the pool is full
stores a Resource in the cache
Adds a name/value pair to the context.
Adds a name/value pair to the context.
Adds a name/value pair to the context.
Impl of the Context.put() method.
Returns the next character from the selected input.
Returns the next character from the selected input.
Reads the data from the datasource.
Fetches the last modification time of the resource
ready - field in class org.apache.velocity.runtime.directive.
Parse resets this class so that it can be reused
Exception thrown when a bad reference is found.
Implementation of ReferenceInsertionEventHandler method
referenceInsert()
.
A call-back which is executed during Velocity merge before a
reference value is inserted into the output stream.
Reference 'Stream insertion' event handler.
Takes an existing resource, and 'refreshes' it.
No op--merely added to satify the Iterator
interface.
Removes the value associated with the specified key from the context.
Removes the value associated with the specified key from the context.
Removes the value associated with the specified key from the context.
removes a Resource from the cache
'Camels Hump' replacement of underscores.
'Camels Hump' replacement.
Removes an event handler(s) from the Cartridge.
Remove underscores from a string and replaces first
letters with capitals.
gets the value of the reference and outputs it to the
writer.
puts the value of the RHS into the context under the key of the LHS
How this directive is to be rendered
renders the #foreach() block
iterates through the argument list and renders every
argument that is appropriate.
Throw the literal rendition of the block between
#literal()/#end into the writer.
render() doesn't do anything in the final output rendering.
iterates through the argument list and renders every
argument that is appropriate.
Renders the macro using the context
does the actual rendering of the included file
determines if replacement of global VMs are allowed
controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL
The context key for the HTTP request object.
Is it time to check to see if the resource
source has been updated?
This class represent a general text resource that
may have been retrieved from any number of possible
sources.
A static content resource.
A static content resource.
Key used to retrieve the names of the resource loaders
to be used.
token used to identify the loader internally
controls if the finding of a resource is logged
Interface that defines the shape of a pluggable resource cache
for the included ResourceManager
Default implementation of the resource cache for the default
ResourceManager.
Determines whether a resource is accessable via the
currently configured resource loaders.
Class responsible for instantiating Resource
objects,
given name and type.
This is abstract class the all text resource loaders should
extend.
The template loader that initially loaded the input
stream for this template, and knows how to check the
source of the input stream for modification.
Factory to grab a template loader.
Each loader needs a configuration object for
its initialization, this flags keeps track of whether
or not the configuration objects have been created
for the resource loaders.
The List of templateLoaders that the Runtime will
use to locate the InputStream source of a template.
Class to manage the text resource for the Velocity
Runtime.
Class to manage the text resource for the Velocity
Runtime.
Application-level exception thrown when a resource of any type
isn't found by the Velocity engine.
The context key for the HTTP response object.
our engine runtime services
handles the dropdown logic when encountering a RPAREN
rsvc - field in class org.apache.velocity.runtime.directive.
Directive rsvc - field in class org.apache.velocity.runtime.resource.loader.
JarHolder rsvc - field in class org.apache.velocity.runtime.parser.
Parser rsvc - field in class org.apache.velocity.runtime.resource.
Resource Runtime services, generally initialized by the
initialize()
method.
rsvc - field in class org.apache.velocity.runtime.parser.node.
SimpleNode runtime services for this instance
rsvc - field in class org.apache.velocity.runtime.directive.
VMProxyArg RUNT - static field in class org.apache.velocity.runtime.parser.node.
ASTReference This is the Runtime system for Velocity.
Location of the velocity log file.
Stack trace output for error messages.
Stack trace output for info messages.
externally provided logger
class of log system to use
Logging of invalid references.
Stack trace output for warning messages.
This class defines the keys that are used in the
velocity.properties file so that they can be referenced as a constant
within Java code.
This is a hashtable of initialized directives.
This is the Runtime system for Velocity.
Interface for internal runtime logging services that are needed by the
Interface for internal runtime services that are needed by the
various components w/in Velocity.
This is the Runtime system for Velocity.
Save the properties to the given outputstream.
If state is true then return the trueString, else
return the falseString.
Applies an XPath expression to this element and returns the resulting
node list.
Applies an XPath expression to the node list and returns the resulting
node list.
sets the permission to add new macros
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.
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.
sets the array of arguments specified in the macro definition
set the switch for automatic reloading of
global library-based VMs
Allow an external system to set an ExtendedProperties
object to use.
Allow an external system to set an ExtendedProperties
object to use.
Allow an external system to set an ExtendedProperties
object to use.
Allow an external system to set an ExtendedProperties
object to use.
Set an entire configuration at once.
Set an entire configuration at once.
Set the context properties that will be
fed into the initial context be the
generating process starts.
[REQUIRED] Set the control template for the
generating process.
Set arbitrary data object that might be used
by the resource.
Initializes the Velocity Runtime with properties file.
Set the destination directory into which the VSL result
files should be copied to
Currently support both types of set :
#set( expr )
#set expr
This method sets the directives Hashtable
set the encoding of this resource
for example, "ISO-8859-1"
Set an entire configuration at once.
Set an entire configuration at once.
Allow people to set the default output file extension
Sets the property value for including other properties files.
Set the input (template) encoding.
Set the input (template) encoding.
Set the last modified time for this
template.
Turn on/off last modified checking.
Routine to allow the literal representation to be
externally overridden.
Allows the template location to be set
Sets the orignal macro body.
Set the modification check interval.
Set the interval at which the InputStream source
should be checked for modifications.
Set the name of this resource, for example
test.vm.
sets the directive name of this VM
public switch to let external user of manager to control namespace
usage indep of properties.
Invoked by VMContext when Context.put() is called for a proxied reference.
[REQUIRED] Set the output directory.
[REQUIRED] Set the output file for the
generation process.
Set the output path for the generated
output.
Allow people to set the path to the project.xml file
Set a property, this will replace any previously
set values.
Allows an external system to set a property in
the Velocity Runtime.
Allows an external system to set a property in
the Velocity Runtime.
Allows an external system to set a property in
the Velocity Runtime.
Allows an external system to set a property in
the Velocity Runtime.
Set a Velocity Runtime property.
Set a Velocity Runtime property.
Sets the reference name that threw this exception
sets the permission for allowing addMacro() calls to
replace existing VM's
Set the template loader for this template.
Sets the runtime logger - this must be called before anything
else besides init() as to get the logger.
Allow people to set the path to the .vsl file
sets permission to have VMs local in scope to their declaring template
note that this is really taken care of in the VMManager class, but
we need it here for gating purposes in addVM
eventually, I will slide this all into the manager, maybe.
Set the path to the templates.
Set the template path, where Texen will look
for Velocity templates.
[REQUIRED] Set the path where Velocity will look
for templates using the file template
loader.
does the housekeeping upon creationg.
Set the use of the classpath in locating templates
Sets the value of a complex reference (something like $foo.bar)
Currently used by ASTSetReference()
Allow people to set the path to the velocity.properties file
This file is found relative to the path where the JVM was run.
Implementation of NullSetEventHandler method
shouldLogOnNullSet()
.
Called when the RHS of a #set() is null, which will result
in a null LHS.
Display the type of nodes and optionally the
first token.
Added this to check and make sure that the configuration
is initialized before trying to get properties from it.
Properly shut down the generator, right now
this is simply flushing and closing the file
writers that we have been holding on to.
Implementation of a simple log4j system that will either
latch onto an existing category, or just do a simple
rolling file log.
the 'de-dollared' reference if we are a ref but don't have a method attached
This is a list of the template input stream source
initializers, basically properties for a particular
template stream source.
This is a map of public name of the template
stream source to it's initializer.
This variable determines which constructor was used to create
this object and thereby affects the semantics of the
"getMessage" method (see below).
Collect all the s that
are carried along with a token.
This field is used to access special tokens that occur prior to this
token, but after the immediately preceding regular (non-special) token.
Create a string array from a string separated by delim
Returns the output of printStackTrace as a String.
These are the types of statements that
are acceptable in Velocity templates.
pushes the current state onto the 'state stack',
and maintains the parens counts
public because we need it in PD & VM handling
pops a state off the stack, and restores paren counts
An attempt wass made to create a second instance of a static token manager.
reference for the object if we proxy for a static arg like an NumberLiteral
This method corresponds to the #stop
directive which just simulates and EOF
so that parsing stops.
Perform a series of substitutions.
This class provides some methods for dynamically
invoking methods in objects, and some string
manipulation methods used by torque.
the File to the style file
last modified of the style sheet
Replaces all instances of oldString with newString in line.
Create a Configurations object that is a subset
of this one.
val - field in class org.apache.velocity.runtime.parser.node.
ASTEscape value - static field in class org.apache.velocity.runtime.parser.node.
ASTFalse value - static field in class org.apache.velocity.runtime.parser.node.
ASTTrue computes the sum of the two nodes.
Returns the value of the expression.
computes the result of the division.
computes the product of the two args.
Returns the value of the expression.
renders the value of the string literal
If the properties allow, and the string literal contains a $ or a #
the literal is rendered against the context
Otherwise, the stringlit is returned.
computes the value of the subtraction.
the VelocityEngine instance to use
ve - field in class org.apache.velocity.texen.
Generator Velocity engine.
Method used for regular method invocation
$foo.bar()
Implementation of VelMethod
VelocimacroFactory.java
manages the set of VMs in a running Velocity engine.
CTOR : requires a runtime services from now
on
Manages VMs in namespaces.
Adds the global namespace to the hash.
VelocimacroProxy.java
a proxy Directive-derived object to fit with the current directive system
This class provides services to the application
developer, such as :
- Simple Velocity Runtime engine initialization methods.
Class that returns alternating values in a template.
Constructor takes an array of Strings.
As VelocityAlternator, but calls alternate()
automatically on rendering in a template.
Constructor takes an array of Strings.
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (without unicode processing).
General purpose implemention of the application Context
interface for general application use.
Creates a new instance (with no inner context).
Creates a new instance with the provided storage (and no inner
context).
Initializes internal storage (never to null
), and
inner context.
Chaining constructor, used when you want to
wrap a context in another.
This class provides a separate new-able instance of the
Velocity template engine.
Base class for Velocity exceptions thrown to the
application layer.
Formatting tool for inserting into the Velocity WebContext.
Constructor needs a backpointer to the context.
the file to get the velocity properties file
Base class which simplifies the use of Velocity with Servlets.
Implementation of a fast Writer.
Create a buffered character-output stream that uses a default-sized
output buffer.
Create a new buffered character-output stream that uses an output
buffer of the given size.
Interface defining a 'getter'.
Interface used for setting values that appear to be properties in
Velocity.
Display an ASTAddNode ( + )
Display an ASTAndNode ( && )
Display an ASTAssignment node ( = )
Display an ASTDivNode ( / )
Display an ASTElseIfStatement node
Display an ASTElseStatement node
Display an ASTEQNode ( == )
Display an ASTExpression node
Display an ASTGENode ( >= )
Display an ASTGTNode ( > )
Display an ASTIdentifier node
Display an ASTIfStatement node
Display an ASTLENode ( <= )
Display an ASTLTNode ( <32)
Display an ASTMethod node
Display an ASTModNode ( % )
Display an ASTMulNode ( * )
Display an ASTNENode ( != )
Display an ASTNotNode ( ! )
Display an ASTNumberLiteral node
Display an ASTOrNode ( || )
Display an ASTprocess node
Display an ASTReference node
Visitor method - if the literal is right, will
set the literal in the ASTReference node
Display an ASTStringLiteral node
Display an ASTSubtractNode ( - )
switch for local context in VM : default false
Name of local Velocimacro library template.
switch for autoloading library-sourced VMs (for development)
Switch for VM blather : default true.
boolean (true/false) default true : allow
inline (in-template) macro definitions
boolean (true/false) default false : allow inline
(in-template) macro definitions to replace existing
Switch for forcing inline macros to be local : default false.
This is a special, internal-use-only context implementation to be
used for the new Velocimacro implementation.
VelocimacroFactory object to manage VMs
VMManager : deal with namespace management
and actually keeps all the VM definitions
The function of this class is to proxy for the calling parameter to the VM.
not used in current impl
Constructor for alternate impl where VelProxy class would make new
VMProxyArg objects, and use this contructor to avoid reparsing the
reference args
that impl also had the VMProxyArg carry it's context
ctor for current impl
takes the reference literal we are proxying for, the literal
the VM we are for is called with...
container for our VMProxy Objects
This class is a visitor used by the VM proxy to change the
literal representation of a reference in a VM.
CTOR - takes a map of args to reference