Library:Apache Jakarta Velocity Engine
Version:1.5
Compatibility:JDK 1.5
Classes in library Apache Jakarta Velocity Engine.
NamePackageDescription
AbstractContextorg.apache.velocity.contextThis class is the abstract base class for all conventional Velocity Context implementations.
AbstractExecutororg.apache.velocity.runtime.parser.nodeAbstract class that is used to execute an arbitrary method that is in introspected.
AnakiaElementorg.apache.velocity.anakiaA JDOM Element that is tailored for Anakia needs.
AnakiaJDOMFactoryorg.apache.velocity.anakiaA customized JDOMFactory for Anakia that produces AnakiaElement instances instead of ordinary JDOM Element instances.
AnakiaTaskorg.apache.velocity.anakiaThe purpose of this Ant Task is to allow you to use Velocity as an XML transformation tool like XSLT is.
AnakiaTask.Contextorg.apache.velocity.anakiaA context implementation that loads all values from an XML file.
ArrayIteratororg.apache.velocity.util

An Iterator wrapper for an Object[].

ASTAddNodeorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTAndNodeorg.apache.velocity.runtime.parser.nodePlease look at the Parser.jjt file which is what controls the generation of this class.
ASTAssignmentorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTBlockorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTCommentorg.apache.velocity.runtime.parser.nodeRepresents all comments...
ASTDirectiveorg.apache.velocity.runtime.parser.nodeThis class is responsible for handling the pluggable directives in VTL.
ASTDivNodeorg.apache.velocity.runtime.parser.nodeHandles number division of nodes

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTElseIfStatementorg.apache.velocity.runtime.parser.nodeThis class is responsible for handling the ElseIf VTL control statement.
ASTElseStatementorg.apache.velocity.runtime.parser.nodeThis class is responsible for handling the Else VTL control statement.
ASTEQNodeorg.apache.velocity.runtime.parser.nodeHandles arg1 == arg2 This operator requires that the LHS and RHS are both of the same Class OR both are subclasses of java.lang.Number
ASTEscapeorg.apache.velocity.runtime.parser.nodeThis class is responsible for handling Escapes in VTL.
ASTEscapedDirectiveorg.apache.velocity.runtime.parser.nodeThis class is responsible for handling EscapedDirectives in VTL.
ASTExpressionorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTFalseorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTFloatingPointLiteralorg.apache.velocity.runtime.parser.nodeHandles floating point numbers.
ASTGENodeorg.apache.velocity.runtime.parser.nodeHandles arg1 >= arg2

Only subclasses of Number can be compared.

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTGTNodeorg.apache.velocity.runtime.parser.nodeHandles arg1 > arg2

Only subclasses of Number can be compared.

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTIdentifierorg.apache.velocity.runtime.parser.nodeASTIdentifier.java Method support for identifiers : $foo mainly used by ASTRefrence Introspection is now moved to 'just in time' or at render / execution time.
ASTIfStatementorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTIncludeStatementorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTIntegerLiteralorg.apache.velocity.runtime.parser.nodeHandles integer numbers.
ASTIntegerRangeorg.apache.velocity.runtime.parser.nodehandles the range 'operator' [ n ..
ASTLENodeorg.apache.velocity.runtime.parser.nodeHandles arg1 <= arg2

Only subclasses of Number can be compared.

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTLTNodeorg.apache.velocity.runtime.parser.nodeHandles arg1 < arg2

Only subclasses of Number can be compared.

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTMaporg.apache.velocity.runtime.parser.nodeAST Node for creating a map / dictionary.
ASTMethodorg.apache.velocity.runtime.parser.nodeASTMethod.java Method support for references : $foo.method() NOTE : introspection is now done at render time.
ASTMethod.MethodCacheKeyorg.apache.velocity.runtime.parser.nodeInternal class used as key for method cache.
ASTModNodeorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTMulNodeorg.apache.velocity.runtime.parser.nodeHandles multiplication

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTNENodeorg.apache.velocity.runtime.parser.nodeHandles arg1 != arg2 This operator requires that the LHS and RHS are both of the same Class OR both are subclasses of java.lang.Number
ASTNotNodeorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTObjectArrayorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTOrNodeorg.apache.velocity.runtime.parser.nodePlease look at the Parser.jjt file which is what controls the generation of this class.
ASTParametersorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTprocessorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTReferenceorg.apache.velocity.runtime.parser.nodeThis class is responsible for handling the references in VTL ($foo).
ASTSetDirectiveorg.apache.velocity.runtime.parser.nodeNode for the #set directive
ASTStoporg.apache.velocity.runtime.parser.nodeThis class is responsible for handling the #stop directive Please look at the Parser.jjt file which is what controls the generation of this class.
ASTStringLiteralorg.apache.velocity.runtime.parser.nodeASTStringLiteral support.
ASTSubtractNodeorg.apache.velocity.runtime.parser.nodeHandles subtraction of nodes (in #set() )

Please look at the Parser.jjt file which is what controls the generation of this class.
ASTTextorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTTrueorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTVariableorg.apache.velocity.runtime.parser.nodeNo description provided.
ASTWordorg.apache.velocity.runtime.parser.nodeNo description provided.
AvalonLogChuteorg.apache.velocity.runtime.logImplementation of a Avalon logger.
AvalonLogSystemorg.apache.velocity.runtime.logImplementation of a Avalon logger.
BaseVisitororg.apache.velocity.runtime.visitorThis is the base class for all visitors.
BooleanPropertyExecutororg.apache.velocity.runtime.parser.nodeHandles discovery and valuation of a boolean object property, of the form public boolean is when executed.
ClassMaporg.apache.velocity.util.introspectionA cache of introspection information for a specific class instance.
ClasspathResourceLoaderorg.apache.velocity.runtime.resource.loaderClasspathResourceLoader is a simple loader that will load templates from the classpath.
ClassUtilsorg.apache.velocity.utilSimple utility functions for manipulating classes and resources from the classloader.
ContentResourceorg.apache.velocity.runtime.resourceThis class represent a general text resource that may have been retrieved from any number of possible sources.
DataSourceResourceLoaderorg.apache.velocity.runtime.resource.loader

This is a simple template file loader that loads templates from a DataSource instead of plain files.

Directiveorg.apache.velocity.runtime.directiveBase class for all directives used in Velocity.
EnumerationIteratororg.apache.velocity.utilAn Iterator wrapper for an Enumeration.
Escapeorg.apache.velocity.anakiaThis class is for escaping CDATA sections.
EscapeHtmlReferenceorg.apache.velocity.app.event.implementEscape all HTML entities.
EscapeJavaScriptReferenceorg.apache.velocity.app.event.implementEscapes the characters in a String to be suitable for use in JavaScript.
EscapeReferenceorg.apache.velocity.app.event.implementBase class for escaping references.
EscapeSqlReferenceorg.apache.velocity.app.event.implementEscapes the characters in a String to be suitable to pass to an SQL query.
EscapeXmlReferenceorg.apache.velocity.app.event.implementEscape all XML entities.
EventCartridgeorg.apache.velocity.app.eventStores the event handlers.
EventHandlerUtilorg.apache.velocity.app.eventCalls on request all registered event handlers for a particular event.
ExceptionUtilsorg.apache.velocity.utilUse this to create a new Exception.
FieldMethodizerorg.apache.velocity.app

This is a small utility class allow easy access to static fields in a class, such as string constants.

FileResourceLoaderorg.apache.velocity.runtime.resource.loaderA loader for templates stored on the file system.
FileUtilorg.apache.velocity.texen.utilA general file utility for use in the context
Foreachorg.apache.velocity.runtime.directiveForeach directive used for moving through arrays, or objects that provide an Iterator.
Foreach.NullHolderContextorg.apache.velocity.runtime.directiveA special context to use when the foreach iterator returns a null.
Generatororg.apache.velocity.texenA text/code generator class
GetExecutororg.apache.velocity.runtime.parser.nodeExecutor that simply tries to execute a get(key) operation.
Includeorg.apache.velocity.runtime.directive

Pluggable directive that handles the #include() statement in VTL.

IncludeEventHandler.IncludeEventExecutororg.apache.velocity.app.eventDefines the execution strategy for includeEvent
IncludeNotFoundorg.apache.velocity.app.event.implementSimple event handler that checks to see if an included page is available.
IncludeRelativePathorg.apache.velocity.app.event.implement

Event handler that looks for included files relative to the path of the current template.

Infoorg.apache.velocity.util.introspectionLittle class to carry in info such as template name, line and column for information error reporting from the uberspector implementations
InputBaseorg.apache.velocity.runtime.directiveBase class for directives which do input operations (e.g.
InternalContextAdapterImplorg.apache.velocity.contextThis adapter class is the container for all context types for internal use.
IntrospectionCacheDataorg.apache.velocity.util.introspectionHolds information for node-local context data introspection information.
Introspectororg.apache.velocity.util.introspectionThis 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.
IntrospectorBaseorg.apache.velocity.util.introspectionLookup a a Method object for a particular class given the name of a method and its parameters.
IntrospectorCacheImplorg.apache.velocity.util.introspectionThis is the internal introspector cache implementation.
InvalidReferenceEventHandler.InvalidGetMethodExecutororg.apache.velocity.app.eventDefines the execution strategy for invalidGetMethod
InvalidReferenceEventHandler.InvalidMethodExecutororg.apache.velocity.app.eventDefines the execution strategy for invalidGetMethod
InvalidReferenceEventHandler.InvalidSetMethodExecutororg.apache.velocity.app.eventDefines the execution strategy for invalidGetMethod
InvalidReferenceInfoorg.apache.velocity.app.event.implementConvenience class to use when reporting out invalid syntax with line, column, and template name.
JarHolderorg.apache.velocity.runtime.resource.loaderA small wrapper around a Jar
JarResourceLoaderorg.apache.velocity.runtime.resource.loader

ResourceLoader to load templates from multiple Jar files.

JdkLogChuteorg.apache.velocity.runtime.logImplementation of a simple java.util.logging LogChute.
Literalorg.apache.velocity.runtime.directiveA very simple directive that leverages the Node.literal() to grab the literal rendition of a node.
Logorg.apache.velocity.runtime.logConvenient wrapper for LogChute functions.
Log4JLogChuteorg.apache.velocity.runtime.logImplementation of a simple log4j system that will either latch onto an existing category, or just do a simple rolling file log.
Log4JLogSystemorg.apache.velocity.runtime.logImplementation of a simple log4j system that will either latch onto an existing category, or just do a simple rolling file log.
LogChuteSystemorg.apache.velocity.runtime.logWrapper to make user's custom LogSystem implementations work with the new LogChute setup.
LogDisplayWrapperorg.apache.velocity.runtime.logThis is a wrapper around a log object, that can add a prefix to log messages and also turn logging on and off dynamically.
LogManagerorg.apache.velocity.runtime.log

This class is responsible for instantiating the correct LogChute

Macroorg.apache.velocity.runtime.directiveMacro.java Macro implements the macro definition directive of VTL.
MapGetExecutororg.apache.velocity.runtime.parser.nodeGetExecutor that is smart about Maps.
MapSetExecutororg.apache.velocity.runtime.parser.nodeSetExecutor that is smart about Maps.
MathUtilsorg.apache.velocity.runtime.parser.nodeUtility-class for all arithmetic-operations.

All operations (+ - / *) return a Number which type is the type of the bigger argument.
Example:
add ( new Integer(10), new Integer(1)) will return an Integer-Object with the value 11
add ( new Long(10), new Integer(1)) will return an Long-Object with the value 11
add ( new Integer(10), new Float(1)) will return an Float-Object with the value 11

Overflow checking:
For integral values (byte, short, int) there is an implicit overflow correction (the next "bigger" type will be returned).
MethodExceptionEventHandler.MethodExceptionExecutororg.apache.velocity.app.eventDefines the execution strategy for methodException
MethodMaporg.apache.velocity.util.introspectionNo description provided.
NodeListorg.apache.velocity.anakiaProvides a class for wrapping a list of JDOM objects primarily for use in template engines and other kinds of text transformation tools.
NodeUtilsorg.apache.velocity.runtime.parser.nodeUtilities for dealing with the AST node structure.
NodeViewModeorg.apache.velocity.runtime.visitorThis class is simply a visitor implementation that traverses the AST, produced by the Velocity parsing process, and creates a visual structure of the AST.
NullLogChuteorg.apache.velocity.runtime.logLogger used in case of failure.
NullLogSystemorg.apache.velocity.runtime.logLogger used in case of failure.
NullSetEventHandler.ShouldLogOnNullSetExecutororg.apache.velocity.app.eventDefines the execution strategy for shouldLogOnNullSet
OutputWrapperorg.apache.velocity.anakiaThis class extends XMLOutputter in order to provide a way to walk an Element tree into a String.
Parseorg.apache.velocity.runtime.directivePluggable directive that handles the #parse() statement in VTL.
Parserorg.apache.velocity.runtime.parserThis class is responsible for parsing a Velocity template.
ParserPoolImplorg.apache.velocity.runtimeThis wraps the original parser SimplePool class.
ParserTokenManagerorg.apache.velocity.runtime.parserNo description provided.
PrimordialLogSystemorg.apache.velocity.runtime.logPre-init logger.
PrintExceptionsorg.apache.velocity.app.event.implementSimple event handler that renders method exceptions in the page rather than throwing the exception.
PropertiesUtilorg.apache.velocity.texen.utilA property utility class for the texen text/code generator Usually this class is only used from a Velocity context.
PropertyExecutororg.apache.velocity.runtime.parser.nodeReturned the value of object property when executed.
PutExecutororg.apache.velocity.runtime.parser.nodeExecutor that simply tries to execute a put(key, value) operation.
ReferenceInsertionEventHandler.referenceInsertExecutororg.apache.velocity.app.eventDefines the execution strategy for referenceInsert
ReportInvalidReferencesorg.apache.velocity.app.event.implementUse this event handler to flag invalid references.
Resourceorg.apache.velocity.runtime.resourceThis class represent a general text resource that may have been retrieved from any number of possible sources.
ResourceCacheImplorg.apache.velocity.runtime.resourceDefault implementation of the resource cache for the default ResourceManager.
ResourceFactoryorg.apache.velocity.runtime.resourceClass responsible for instantiating Resource objects, given name and type.
ResourceLoaderorg.apache.velocity.runtime.resource.loaderThis is abstract class the all text resource loaders should extend.
ResourceLoaderFactoryorg.apache.velocity.runtime.resource.loaderFactory to grab a template loader.
ResourceManagerImplorg.apache.velocity.runtime.resourceClass to manage the text resource for the Velocity Runtime.
Runtimeorg.apache.velocity.runtimeThis is the Runtime system for Velocity.
RuntimeInstanceorg.apache.velocity.runtimeThis is the Runtime system for Velocity.
RuntimeLoggerLogorg.apache.velocity.runtime.logA temporary RuntimeLogger wrapper to make the deprecation of UberspectLoggable.setRuntimeLogger(RuntimeLogger) feasible.
RuntimeSingletonorg.apache.velocity.runtimeThis is the Runtime system for Velocity.
SecureIntrospectorImplorg.apache.velocity.util.introspection

Prevent "dangerous" classloader/reflection related calls.

SecureUberspectororg.apache.velocity.util.introspectionUse a custom introspector that prevents classloader related method calls.
SetExecutororg.apache.velocity.runtime.parser.nodeAbstract class that is used to execute an arbitrary method that is in introspected.
SetPropertyExecutororg.apache.velocity.runtime.parser.nodeExecutor for looking up property names in the passed in class This will try to find a set<foo>(key, value) method
SimpleLog4JLogSystemorg.apache.velocity.runtime.log

This class is deprecated in favor of the new Log4JLogChute , which makes use of Log4J's Logger rather than its deprecated Category class.

SimpleNodeorg.apache.velocity.runtime.parser.nodeNo description provided.
SimplePoolorg.apache.velocity.utilSimple object pool.
StringResourceorg.apache.velocity.runtime.resource.utilWrapper for Strings containing templates, allowing to add additional meta data like timestamps.
StringResourceLoaderorg.apache.velocity.runtime.resource.loaderResource loader that works with Strings.
StringResourceRepositoryImplorg.apache.velocity.runtime.resource.utilDefault implementation of StringResourceRepository.
StringUtilsorg.apache.velocity.utilThis class provides some methods for dynamically invoking methods in objects, and some string manipulation methods used by torque.
SystemLogChuteorg.apache.velocity.runtime.logLogger used when no other is configured.
Templateorg.apache.velocityThis class is used for controlling all template operations.
TexenTaskorg.apache.velocity.texen.antAn ant task for generating output by using Velocity
Tokenorg.apache.velocity.runtime.parserDescribes the input token stream.
TreeWalkerorg.apache.velocity.anakiaThis class allows you to walk a tree of JDOM Element objects.
UberspectImplorg.apache.velocity.util.introspectionImplementation of Uberspect to provide the default introspective functionality of Velocity
UberspectImpl.VelGetterImplorg.apache.velocity.util.introspectionNo description provided.
UberspectImpl.VelMethodImplorg.apache.velocity.util.introspectionImplementation of VelMethod
UberspectImpl.VelSetterImplorg.apache.velocity.util.introspectionNo description provided.
UnicodeInputStreamorg.apache.velocity.ioThis is an input stream that is unicode BOM aware.
URLResourceLoaderorg.apache.velocity.runtime.resource.loaderThis is a simple URL-based loader.
VelocimacroFactoryorg.apache.velocity.runtimeVelocimacroFactory.java manages the set of VMs in a running Velocity engine.
VelocimacroManagerorg.apache.velocity.runtimeManages VMs in namespaces.
VelocimacroProxyorg.apache.velocity.runtime.directiveVelocimacroProxy.java a proxy Directive-derived object to fit with the current directive system
Velocityorg.apache.velocity.appThis class provides services to the application developer, such as :
  • Simple Velocity Runtime engine initialization methods.
VelocityCharStreamorg.apache.velocity.runtime.parserAn implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).
VelocityContextorg.apache.velocityGeneral purpose implemention of the application Context interface for general application use.
VelocityEngineorg.apache.velocity.app

This class provides a separate new-able instance of the Velocity template engine.

VelocityFormatterorg.apache.velocity.app.toolsFormatting tool for inserting into the Velocity WebContext.
VelocityFormatterorg.apache.velocity.runtime.logNo description provided.
VelocityFormatter.VelocityAlternatororg.apache.velocity.app.toolsClass that returns alternating values in a template.
VelocityFormatter.VelocityAutoAlternatororg.apache.velocity.app.toolsAs VelocityAlternator, but calls alternate() automatically on rendering in a template.
VelocityServletorg.apache.velocity.servletBase class which simplifies the use of Velocity with Servlets.
VelocityWriterorg.apache.velocity.ioImplementation of a fast Writer.
VMContextorg.apache.velocity.contextThis is a special, internal-use-only context implementation to be used for the new Velocimacro implementation.
VMProxyArgorg.apache.velocity.runtime.directiveThe function of this class is to proxy for the calling parameter to the VM.
VMReferenceMungeVisitororg.apache.velocity.runtime.visitorThis class is a visitor used by the VM proxy to change the literal representation of a reference in a VM.
WebMacroorg.apache.velocity.convertThis class will convert a WebMacro template to a Velocity template.
XPathToolorg.apache.velocity.anakiaThis class adds an entrypoint into XPath functionality, for Anakia.
Search