| Class Summary | |
|---|---|
| AbstractContext | This class is the abstract base class for all conventional Velocity Context implementations. |
| AbstractExecutor | Abstract class that is used to execute an arbitrary method that is in introspected. |
| AnakiaElement | A JDOM Element that is tailored for Anakia needs. |
| AnakiaJDOMFactory | A customized JDOMFactory for Anakia that produces AnakiaElement instances instead of ordinary JDOM Element instances. |
| AnakiaTask | The purpose of this Ant Task is to allow you to use Velocity as an XML transformation tool like XSLT is. |
| AnakiaTestCase | This is a test case for Anakia. |
| ArrayIterator |
An Iterator wrapper for an Object[]. |
| ASTAddNode | Handles integer addition of nodes Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTAndNode | Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTAssignment | |
| ASTBlock | |
| ASTComment | Represents all comments... |
| ASTDirective | This class is responsible for handling the pluggable directives in VTL. ex. |
| ASTDivNode | Handles integer division of nodes Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTElseIfStatement | This class is responsible for handling the ElseIf VTL control statement. |
| ASTElseStatement | This class is responsible for handling the Else VTL control statement. |
| ASTEQNode |
Handles the equivalence operator
|
| ASTEscape | This class is responsible for handling Escapes in VTL. |
| ASTEscapedDirective | This class is responsible for handling EscapedDirectives in VTL. |
| ASTExpression | |
| ASTFalse | |
| ASTGENode | |
| ASTGTNode | |
| ASTIdentifier | ASTIdentifier.java Method support for identifiers : $foo mainly used by ASTRefrence Introspection is now moved to 'just in time' or at render / execution time. |
| ASTIfStatement | Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTIncludeStatement | |
| ASTIntegerRange | handles the range 'operator' [ n .. m ] Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTLENode | |
| ASTLTNode | |
| ASTMethod | ASTMethod.java Method support for references : $foo.method() NOTE : introspection is now done at render time. |
| ASTModNode | Handles integer modulus division Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTMulNode | Handles integer multiplication Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTNENode | |
| ASTNotNode | |
| ASTNumberLiteral | |
| ASTObjectArray | |
| ASTOrNode | Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTprocess | |
| ASTParameters | |
| ASTReference | This class is responsible for handling the references in VTL ($foo). |
| ASTSetDirective | Node for the #set directive |
| ASTStringLiteral | ASTStringLiteral support. |
| ASTSubtractNode | Handles integer subtraction of nodes (in #set() ) Please look at the Parser.jjt file which is what controls the generation of this class. |
| ASTText | |
| ASTTrue | |
| ASTVariable | |
| ASTWord | |
| AvalonLogSystem | Implementation of a Avalon logger. |
| BaseTestCase | Base test case that provides a few utility methods for the rest of the tests. |
| BaseVisitor | This is the base class for all visitors. |
| BooleanPropertyExecutor |
Handles discovery and valuation of a
boolean object property, of the
form public boolean is |
| BoolObj | simple class to test boolean property introspection - can't use TestProvider as there is a get( String ) and that comes before isProperty in the search pattern |
| CharStream | This interface describes a character stream that maintains line and column number positions of the characters. |
| Child | Rudimentary class used in the testbed to test introspection with subclasses of a particular class. |
| ClassloaderChangeTest | Tests if we can hand Velocity an arbitrary class for logging. |
| ClassMap | A cache of introspection information for a specific class instance. |
| ClassMap.CacheMiss | |
| ClassMap.MethodInfo | Used for the iterative discovery process for public methods. |
| ClasspathResourceLoader | ClasspathResourceLoader is a simple loader that will load templates from the classpath. |
| ClasspathResourceTest | Load templates from the Classpath. |
| CommonsExtPropTestCase | Tests for the Commons ExtendedProperties class. |
| Compiler | The start of a velocity template compiler. |
| Configuration | 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. |
| ConfigurationTestCase | Tests for the Configuration class. |
| Configuration.PropertiesReader | This class is used to read properties lines. |
| Configuration.PropertiesTokenizer | This class divides into tokens a property value. |
| ContentResource | This class represent a general text resource that may have been retrieved from any number of possible sources. |
| Context | Interface describing the application data context. |
| ContextSafetyTestCase | Tests if we are context safe : can we switch objects in the context and re-merge the template safely. |
| DataSourceResourceLoader | This is a simple template file loader that loads templates from a DataSource instead of plain files. |
| Directive | Base class for all directives used in Velocity. |
| DirectiveConstants | Base class for all directives used in Velocity. |
| EncodingTestCase | Tests input encoding handling. |
| EnumerationIterator | An Iterator wrapper for an Enumeration. |
| Escape | This class is for escaping CDATA sections. |
| EventCartridge | 'Package' of event handlers... |
| EventHandler | Base interface for all event handlers |
| EventHandlingTestCase | Tests event handling |
| ExternalLoggerTest | Tests if we can hand Velocity an arbitrary class for logging. |
| FieldMethodizer |
This is a small utility class allow easy access to static fields in a class, such as string constants. |
| FileResourceLoader | A loader for templates stored on the file system. |
| FileUtil | A general file utility for use in the context |
| Foreach | Foreach directive used for moving through arrays, or objects that provide an Iterator. |
| Generator | A text/code generator class |
| GetExecutor | Executor that simply tries to execute a get(key) operation. |
| Include | Pluggable directive that handles the #include() statement in VTL. |
| Info | Little class to carry in info such as template name, line and column for information error reporting from the uberspector implementations |
| InlineScopeVMTestCase | Tests if the VM template-locality is working. |
| InputBase | Base class for directives which do input operations (e.g. |
| InternalContextAdapter | interface to bring all necessary internal and user contexts together. this is what the AST expects to deal with. |
| InternalContextAdapterImpl | This adapter class is the container for all context types for internal use. |
| InternalContextBase | class to encapsulate the 'stuff' for internal operation of velocity. |
| InternalEventContext | Interface for event support. |
| InternalHousekeepingContext | interface to encapsulate the 'stuff' for internal operation of velocity. |
| InternalWrapperContext | interface for internal context wrapping functionality |
| IntrospectionCacheData | Holds information for node-local context data introspection information. |
| Introspector | 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. |
| IntrospectorBase | 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. |
| IntrospectorTestCase | Test case for the Velocity Introspector which uses the Java Reflection API to determine the correct signature of the methods used in VTL templates. |
| IntrospectorTestCase2 | Test case for the Velocity Introspector which tests the ability to find a 'best match' |
| IntrospectorTestCase2.Bar | |
| IntrospectorTestCase2.Foo | |
| IntrospectorTestCase2.Tester | |
| IntrospectorTestCase2.Tester2 | |
| IntrospectorTestCase2.Woogie | |
| IntrospectorTestCase3 | Simple introspector test case for primitive problem found in 1.3 |
| IntrospectorTestCase3.MethodProvider | |
| IntrospectorTestCase.MethodProvider | |
| JarHolder | A small wrapper around a Jar |
| JarResourceLoader |
ResourceLoader to load templates from multiple Jar files. |
| JJTParserState | |
| Literal | A very simple directive that leverages the Node.literal() to grab the literal rendition of a node. |
| Log4JLogSystem | Implementation of a Log4J logger. |
| LogManager |
This class is responsible for instantiating the correct LoggingSystem The approach is :
|
| LogSystem | Base interface that Logging systems need to implement. |
| Macro | Macro.java Macro implements the macro definition directive of VTL. example : #macro( isnull $i ) #if( $i ) $i #end #end This object is used at parse time to mainly process and register the macro. |
| MacroParseException | Exception to indicate problem happened while constructing #macro() For internal use in parser - not to be passed to app level |
| MethodExceptionEventHandler | Called when a method throws an exception. |
| MethodInvocationException | Application-level exception thrown when a reference method is invoked and an exception is thrown. |
| MethodInvocationExceptionTest | Tests if we can hand Velocity an arbitrary class for logging. |
| MethodMap | |
| MethodMap.AmbiguousException | simple distinguishable exception, used when we run across ambiguous overloading |
| MiscTestCase | Test case for any miscellaneous stuff. |
| MultiLoaderTestCase | Load templates from the Classpath. |
| MultipleFileResourcePathTest | Multiple paths in the file resource loader. |
| Node | All AST nodes must implement this interface. |
| NodeException | |
| NodeList | Provides a class for wrapping a list of JDOM objects primarily for use in template engines and other kinds of text transformation tools. |
| NodeList.AttributeXMLOutputter | A special subclass of XMLOutputter that will be used to output Attribute nodes. |
| NodeUtils | Utilities for dealing with the AST node structure. |
| NodeViewMode | This class is simply a visitor implementation that traverses the AST, produced by the Velocity parsing process, and creates a visual structure of the AST. |
| NullLogSystem | Logger used in case of failure. |
| NullSetEventHandler | Event handler : lets an app approve / veto writing a log message when RHS of #set() is null. |
| OutputWrapper | This class extends XMLOutputter in order to provide a way to walk an Element tree into a String. |
| Parse |
Pluggable directive that handles the #parse()
statement in VTL.
|
| ParseDirectiveException | Exception for #parse() problems |
| ParseErrorException | Application-level exception thrown when a resource of any type has a syntax or other error which prevents it from being parsed. |
| ParseException | This exception is thrown when parse errors are encountered. |
| Parser | This class is responsible for parsing a Velocity template. |
| ParserConstants | |
| ParserTestCase | More specific parser tests where just templating isn't enough. |
| ParserTokenManager | |
| ParserTreeConstants | |
| ParserVisitor | |
| Parser.JJCalls | |
| Person | Rudimentary class used in the testbed to test introspection with subclasses of a particular class. |
| PrimordialLogSystem | Pre-init logger. |
| PropertiesUtil | A property utility class for the texen text/code generator Usually this class is only used from a Velocity context. |
| PropertyExecutor | Returned the value of object property when executed. |
| ReferenceException | Exception thrown when a bad reference is found. |
| ReferenceInsertionEventHandler | Reference 'Stream insertion' event handler. |
| Resource | This class represent a general text resource that may have been retrieved from any number of possible sources. |
| ResourceCache | Interface that defines the shape of a pluggable resource cache for the included ResourceManager |
| ResourceCacheImpl | Default implementation of the resource cache for the default ResourceManager. |
| ResourceFactory |
Class responsible for instantiating Resource objects,
given name and type.
|
| ResourceLoader | This is abstract class the all text resource loaders should extend. |
| ResourceLoaderFactory | Factory to grab a template loader. |
| ResourceManager | Class to manage the text resource for the Velocity Runtime. |
| ResourceManagerImpl | Class to manage the text resource for the Velocity Runtime. |
| ResourceNotFoundException | Application-level exception thrown when a resource of any type isn't found by the Velocity engine. |
| Runtime | This is the Runtime system for Velocity. |
| RuntimeConstants | 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. |
| RuntimeInstance | This is the Runtime system for Velocity. |
| RuntimeLogger | Interface for internal runtime logging services that are needed by the |
| RuntimeServices | Interface for internal runtime services that are needed by the various components w/in Velocity. |
| RuntimeSingleton | This is the Runtime system for Velocity. |
| SimpleLog4JLogSystem | Implementation of a simple log4j system that will either latch onto an existing category, or just do a simple rolling file log. |
| SimpleNode | |
| SimplePool | Simple object pool. |
| StringUtils | This class provides some methods for dynamically invoking methods in objects, and some string manipulation methods used by torque. |
| Template | This class is used for controlling all template operations. |
| TemplateNodeView | Simple class for dumping the AST for a template. |
| TemplateTestBase | This is a base interface that contains a bunch of static final strings that are of use when testing templates. |
| TemplateTestCase | Easily add test cases which evaluate templates and check their output. |
| TemplateTestSuite | Test suite for Templates. |
| Test | This class the testbed for Velocity. |
| TestClassloader | Simple (real simple...) classloader that depends on a Foo.class being located in the classloader directory under test |
| TestProvider | This class is used by the testbed. |
| TexenClasspathTestCase | This is a test case for Texen. |
| TexenTask | An ant task for generating output by using Velocity |
| TexenTestCase | This is a test case for Texen. |
| Token | Describes the input token stream. |
| TokenMgrError | |
| TreeWalker | This class allows you to walk a tree of JDOM Element objects. |
| Uberspect | 'Federated' introspection/reflection interface to allow the introspection behavior in Velocity to be customized. |
| UberspectImpl | Implementation of Uberspect to provide the default introspective functionality of Velocity |
| UberspectImpl.VelGetterImpl | |
| UberspectImpl.VelMethodImpl | Implementation of VelMethod |
| UberspectImpl.VelSetterImpl | |
| UberspectLoggable | Marker interface to let an uberspector indicate it can and wants to log Thanks to Paulo for the suggestion |
| VelMethod | Method used for regular method invocation $foo.bar() |
| VelocimacroFactory | VelocimacroFactory.java manages the set of VMs in a running Velocity engine. |
| VelocimacroFactory.Twonk | small continer class to hold the duple of a template and modification time. |
| VelocimacroManager | Manages VMs in namespaces. |
| VelocimacroManager.MacroEntry | wrapper class for holding VM information |
| VelocimacroProxy | VelocimacroProxy.java a proxy Directive-derived object to fit with the current directive system |
| VelocimacroTestCase | This class tests strange Velocimacro issues. |
| Velocity |
This class provides services to the application
developer, such as :
|
| VelocityAppTestCase | This class is intended to test the app.Velocity.java class. |
| VelocityCharStream | An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing). |
| VelocityContext | General purpose implemention of the application Context interface for general application use. |
| VelocityEngine |
This class provides a separate new-able instance of the Velocity template engine. |
| VelocityException | Base class for Velocity exceptions thrown to the application layer. |
| VelocityFormatter | Formatting tool for inserting into the Velocity WebContext. |
| VelocityFormatter | |
| VelocityFormatter.VelocityAlternator | Class that returns alternating values in a template. |
| VelocityFormatter.VelocityAutoAlternator |
As VelocityAlternator, but calls alternate()
automatically on rendering in a template. |
| VelocityServlet | Base class which simplifies the use of Velocity with Servlets. |
| VelocityServletTest | Tests our VelocityServlet implementation. |
| VelocityServletTest.MockHttpServletResponse | |
| VelocityServletTest.MockServletConfig | |
| VelocityServletTest.MockServletContext | |
| VelocityServletTest.MockVelocityServlet | |
| VelocityWriter | Implementation of a fast Writer. |
| VelPropertyGet | Interface defining a 'getter'. |
| VelPropertySet | Interface used for setting values that appear to be properties in Velocity. |
| VMContext | This is a special, internal-use-only context implementation to be used for the new Velocimacro implementation. |
| VMProxyArg | The function of this class is to proxy for the calling parameter to the VM. |
| VMReferenceMungeVisitor | This class is a visitor used by the VM proxy to change the literal representation of a reference in a VM. |
| WebMacro | This class will convert a WebMacro template to a Velocity template. |
| XPathCache | Provides a cache for XPath expressions. |
| XPathTool | This class adds an entrypoint into XPath functionality, for Anakia. |