All Classes

Class	Description
AbstractLockConfig	Deprecated. Use SafeConfig instead
AbstractPagerTool	Deprecated.
AbstractSearchTool	Abstract view tool for doing "searching" and robust pagination of search results.
AbstractSearchTool	Deprecated.
AbstractSearchTool.StoredResults	Simple utility class to hold a criterion and its result list.
ActionMessagesTool	This tool deals with Struts action messages.
Alternator	Utility class for easily alternating over values in a list.
AlternatorTool	Simple tool to provide easy in-template instantiation of Alternators from varying "list" types or individual arguments.
BrowserSnifferTool	Deprecated.
BrowserTool	browser-sniffing tool (session or request scope requested, session scope advised).
ChainedContext	Deprecated. Use ViewToolContext instead
ClassTool	This tool is meant to simplify reflective lookup of information about a Class and its Fields, Methods, and Constructors.
ClassTool.CallableSub<T extends ClassTool.CallableSub>
ClassTool.ConstructorSub	A simplified wrapping interface for inspecting features of a Constructor in an inspected Class.
ClassTool.FieldSub	A simplified wrapping interface for inspecting features of a Field in an inspected Class.
ClassTool.MethodSub	A simplified wrapping interface for inspecting features of a Method in an inspected Class.
ClassTool.Sub<T extends ClassTool.Sub>
ClassUtils	Repository for common class and reflection methods.
CommonsLogLogSystem	Deprecated. Use CommonsLogLogChute in Velocity 1.6 instead.
ComparisonDateTool	Tool for comparing Date and Calendar values in Velocity templates.
CompoundConfiguration<C extends Configuration>	This class manages a SortedSet of child Configurations as well as being a Configuration itself.
Configuration	This base configuration class manages a set of Propertys for whatever thing the instance of this class represents.
ConfigurationCleaner
ConfigurationException
ConfigurationUtils	Utility methods for handling tool configurations.
ContextTool	Tool for convenient access to Context data and meta-data.
ContextTool	Deprecated.
ConversionTool	Utility class for easy conversion of String values to richer types.
ConversionUtils	Utility methods for parsing or otherwise converting between types.
CookieTool	View tool for convenient cookie access and creation.
CookieTool	Deprecated.
CookieTool.SugarCookie	Extends Cookie to add some fluid API sugar and a toString() method that renders the Cookie's value instead of the usual Object.toString() shenanigans.
Data	This class represents configured data.
Data.AutoConverter
Data.FieldConverter
Data.NumberConverter
Data.Type	Delineates the standard, known types and their associated target classes (Data.setTargetClass(java.lang.Class) and converters (Data.setConverter(java.lang.Class)).
DataInfo	Deprecated. Use Data
DateTool	Tool for working with Date and Calendar in Velocity templates.
DefaultKey	Annotation specifying the default key to use for a tool class in the case none was specified.
DisplayTool	Provides general utility methods for controlling the display of references.
DisplayTool.Measurements	Measures the dimensions of the string given to its constructor.
EasyFactoryConfiguration	FactoryConfiguration subclass that simplifies the process of configuring a ToolboxFactory in Java without the use of an xml or properties configuration file.
EasyFactoryConfiguration.EasyData
ErrorsTool	This tool deals with Struts error messages.
EscapeTool	Tool for working with escaping in Velocity templates.
FactoryConfiguration	This class serves to define configuration info for a ToolboxFactory.
FieldTool	This is a simple tools class to allow easy access to static fields in a class, such as string constants from within a template.
FieldTool.FieldToolSub	Holds a Map of results for a particular class.
FieldTool.MutableField	Holds a Field and Class reference for later retrieval of the value of a field that is not final and may change at different lookups.
FileFactoryConfiguration	Provides support for reading a configuration file from a specified path, This frees the user from having to obtain an InputStream themselves.
FormatConfig	Implements common logic and constants for tools which allow their default format to be configured.
FormTool	View tool to work with HTML forms in Struts.
ImportSupport	Provides methods to import arbitrary local or remote resources as strings.
ImportSupport.ImportResponseWrapper	Wraps responses to allow us to retrieve results as Strings.
ImportSupport.SafeClosingHttpURLConnectionReader
ImportTool	General-purpose text-importing view tool for templates.
ImportTool	Deprecated.
IncludeTool	Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.
InvalidScope
InvalidScopeException
IteratorTool	Deprecated. Use LoopTool instead
JeeConfig	Because sometimes you don't care about the difference between a servlet and a filter.
JeeContextConfig	Implements JeeConfig with only a ServletContext.
JeeFilterConfig	Implements JeeConfig with a FilterConfig.
JeeServletConfig	Implements JeeConfig with a ServletConfig.
JspToolContext	Velocity context implementation specific to the JSP environment.
LinkTool	The LinkTool provides many methods to work with URIs and can help you: construct full URIs (opaque, absolute or relative) encode and decode URLs (part or whole) retrieve path info for the current request and more..
LinkTool	The LinkTool provides many methods to work with URIs and can help you: construct full URIs (absolute or relative) encode session ID into a URI retrieve server, port and path info for the current request reconstruct or alter the current request URI and more..
LinkTool	Deprecated. Use LinkTool
ListTool	Deprecated.
LocaleConfig	Implements common logic and constants for tools which allow their default Locale to be configured.
LogChuteCommonsLog	Redirects commons-logging messages to Velocity's configured LogChute.
LogSupport	This allows for a Log to optionally be attached to a subclass in order to output logging messages.
LogSystemCommonsLog	Deprecated. Use LogChuteCommonsLog instead
LoopTool	A convenience tool to use with #foreach loops.
LoopTool.Action	Represents an automatic action taken by a LoopTool.ManagedIterator when a LoopTool.Condition is satisfied by the subsequent element.
LoopTool.ActionCondition	Composition class which associates an LoopTool.Action and LoopTool.Condition for a LoopTool.ManagedIterator.
LoopTool.Comparison	Base condition class for conditions (assumption here is that conditions are all comparative.
LoopTool.Condition	Represents a function into which a LoopTool.ManagedIterator can pass it's next element to see if an LoopTool.Action should be taken.
LoopTool.Equals	Simple condition that checks elements in the iterator for equality to a specified Object.
LoopTool.ManagedIterator	Iterator implementation that wraps a standard Iterator and allows it to be prematurely stopped, skipped ahead, and associated with a name for advanced nested loop control.
LoopTool.SyncedIterator	Simple wrapper to make it easy to keep an arbitray Iterator in sync with a LoopTool.ManagedIterator.
MarkupTool	NOTE: This tools is considered "alpha" quality due to lack of testing and a generally unpolished API.
MarkupTool.Tag
MathTool	Tool for performing math in Velocity.
MessageResourcesTool	Abstract view tool that provides access to Struts' message resources.
MessageTool	The MessageTool is used to render internationalized message strings.
MultiViewsTool	Deprecated.
NullKeyException
NumberTool	Tool for working with Number in Velocity templates.
OldToolInfo	Manages old tools which still use the deprecated init() method.
OldXmlFactoryConfigurationRuleSet	Deprecated. This is provided merely for 1.x compatibility.
OldXmlFactoryConfigurationRuleSet.BooleanConfigRule
OldXmlFactoryConfigurationRuleSet.CreateSessionRule
OldXmlFactoryConfigurationRuleSet.DeprecationRule
OldXmlFactoryConfigurationRuleSet.ParameterRule
OldXmlFactoryConfigurationRuleSet.ScopeRule
OldXmlFactoryConfigurationRuleSet.SetNextDataRule
OldXmlFactoryConfigurationRuleSet.XhtmlRule
PagerTool	View tool for doing request-based pagination of items in an a list.
ParameterParser	Deprecated.
ParameterTool	Utility class for easy parsing of ServletRequest parameters.
PropertiesFactoryConfiguration	This reads in configuration info formatted as a property file using ExtendedProperties from Commons-Collections.
Property	Simple extension of Data that treats "name" as an alias for "key".
RenderTool	This tool exposes methods to evaluate the given strings as VTL (Velocity Template Language) using either a pre-configured context or one you provide directly.
ResourceTool	Tool for accessing ResourceBundles and formatting messages therein.
SafeConfig	Implements common logic and constants for tools which automatically locks down the public void configure(Map params) method after it is called once.
Scope	A specialized constants class to provide some compile-time typo checking and runtime validation for scopes specified in annotations, toolbox configs, etc.
SecureLinkTool	Tool to be able to use Struts SSL Extensions with Velocity.
ServletLogChute	Deprecated. This class has been moved to Velocity Engine 1.6+ and only remains here temporarily for users of previous Velocity Engine versions.
ServletLogger	Deprecated. Use ServletLogChute instead
ServletToolboxManager	Deprecated. Use XmlFactoryConfiguration
ServletToolboxRuleSet	Deprecated. Use XmlFactoryConfigurationRuleSet.
ServletToolInfo	Deprecated. Use ToolInfo
ServletUtils	Deprecated. Use ServletUtils
ServletUtils	A set of utility methods for supporting and using VelocityTools in the servlet environment.
SkipSetters	Annotation specifying that ToolInfo should only use the public void configure(Map) method for configuration of a tool, and skip over the step of trying to find individual property setters.
SortTool	SortTool allows a user to sort a collection (or array, iterator, etc) on any arbitary set of properties exposed by the objects contained within the collection.
SortTool.PropertiesComparator	Does all of the comparisons
StrutsLinkTool	The StrutsLinkTool extends the standard LinkTool to add methods for working with Struts' Actions and Forwards:
StrutsUtils	A utility class to expose the Struts shared resources.
TilesTool	The TilesTool is used to interact with the Struts-Tiles framework that is part of Struts 1.
Toolbox	Instances of this class are typically created by a ToolboxFactory on a one-per-scope basis.
ToolboxConfiguration	This class handles configuration info for the Toolbox instances that will eventually be produced by ToolboxFactory.
ToolboxFactory	This class is the central point of action for VelocityTools.
ToolboxManager	Deprecated.
ToolboxRuleSet	Deprecated. Use XmlFactoryConfigurationRuleSet
ToolboxRuleSet.ParameterRule
ToolConfiguration	This class handles configuration info for tools, including their key, classname, path restriction, and properties.
ToolContext	Context implementation that keeps a list of Toolboxes and returns them as requested, using its internal context Map as the dynamic properties passed to the requested tools when they are first created.
ToolInfo	Manages data needed to create instances of a tool.
ToolInfo	Deprecated. Use ToolInfo
ToolManager	Manages tools for non-web applications.
UiDependencyTool	NOTE: This tool is considered "beta" quality due to lack of public testing and is not automatically provided via the default tools.xml file.
UiDependencyTool.FileRule	NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.Group	NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.GroupRule	NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.NeedsRule	NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.TypeRule	NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
ValidatorTool	View tool that works with Struts Validator to produce client side javascript validation for your forms.
ValidScope
ValueParser	Utility class for easy parsing of String values held in a Map.
VelocityLayoutServlet	Deprecated. This has moved to VelocityLayoutServlet
VelocityLayoutServlet	Extension of the VelocityViewServlet to perform "two-pass" layout rendering and allow for a customized error screen.
VelocityView	The class provides the following features:
VelocityViewFilter	A filter to ensure VelocityTools Toolboxes are available in the request/session/application scopes.
VelocityViewServlet	Deprecated. This class has moved to VelocityViewServlet
VelocityViewServlet	A servlet to process Velocity templates.
VelocityViewTag	This tag enables use of Velocity and VelocityTools within JSP files and tags.
ViewContext	Deprecated. Use ViewContext
ViewContext	This interface provides view tools in a servlet environment access to relevant context information, like servlet request, servlet context and the velocity context.
ViewContextTool	Extension of ContextTool that includes keys and values from the HttpServletRequest, HttpSession and ServletContext.
ViewRenderTool	Deprecated.
ViewResourceTool	Deprecated.
ViewToolContext	ToolContext implementation specific to the servlet environment.
ViewToolInfo	Deprecated. Use ToolInfo
ViewToolManager	Manages tools for web applications.
WebappLoader	Deprecated. Use WebappResourceLoader instead.
WebappResourceLoader	Resource loader that uses the ServletContext of a webapp to load Velocity templates.
WebappUberspector	This custom uberspector allows getAttribute() and setAttribute() as standard getters and setters for the "request","session" and "application" keys.
XmlFactoryConfiguration	This reads in configuration info formatted as an XML file using Commons-Digester.
XmlFactoryConfigurationRuleSet	This provides set of Rules used by Commons-Digester to process configuration info formatted as XML.
XmlFactoryConfigurationRuleSet.DataValueInBodyRule	Rule for adding configuration properties
XmlFactoryConfigurationRuleSet.PropertyAttributeRule
XmlTool	Tool for reading/navigating XML files.
XmlTool.NodeIterator	Iterator implementation that wraps a Node list iterator to return new XmlTool instances for each item in the wrapped iterator.s
XMLToolboxManager	Deprecated. Use XmlFactoryConfiguration