Library:Apache Jakarta Velocity Tools
Version:2.0-beta.1
Compatibility:JDK 1.5
Classes in library Apache Jakarta Velocity Tools.
NamePackageDescription
AbstractLockConfigorg.apache.velocity.tools.genericImplements common logic and constants for tools which automatically locks down the public void configure(Map params) method after it is called once.
AbstractPagerToolorg.apache.velocity.tools.view.toolsUse PagerTool
AbstractSearchToolorg.apache.velocity.tools.view.toolsUse AbstractSearchTool
AbstractSearchToolorg.apache.velocity.tools.view

Abstract view tool for doing "searching" and robust pagination of search results.

AbstractSearchTool.StoredResultsorg.apache.velocity.tools.viewSimple utility class to hold a criterion and its result list.
ActionMessagesToolorg.apache.velocity.tools.struts

This tool deals with Struts action messages.

Alternatororg.apache.velocity.tools.genericUtility class for easily alternating over values in a list.
AlternatorToolorg.apache.velocity.tools.genericSimple tool to provide easy in-template instantiation of Alternator s from varying "list" types or individual arguments.
BrowserSnifferToolorg.apache.velocity.tools.view.toolsUse BrowserTool
BrowserToolorg.apache.velocity.tools.view

browser-sniffing tool (session or request scope requested, session scope advised).

ChainedContextorg.apache.velocity.tools.view.contextNo description provided.
ClassToolorg.apache.velocity.tools.generic

This tool is meant to simplify reflective lookup of information about a Class and its Field s, Method s, and Constructor s.

ClassTool.CallableSuborg.apache.velocity.tools.genericNo description provided.
ClassTool.ConstructorSuborg.apache.velocity.tools.genericA simplified wrapping interface for inspecting features of a Constructor in an inspected Class.
ClassTool.FieldSuborg.apache.velocity.tools.genericA simplified wrapping interface for inspecting features of a Field in an inspected Class.
ClassTool.MethodSuborg.apache.velocity.tools.genericA simplified wrapping interface for inspecting features of a Method in an inspected Class.
ClassTool.Suborg.apache.velocity.tools.genericNo description provided.
ClassUtilsorg.apache.velocity.toolsRepository for common class and reflection methods.
CommonsLogLogSystemorg.apache.velocity.tools.generic.logRedirects Velocity's LogSystem messages to commons-logging.
ComparisonDateToolorg.apache.velocity.tools.genericTool for comparing Date and Calendar values in Velocity templates.
ComparisonDateTool.Comparisonorg.apache.velocity.tools.genericNo description provided.
CompoundConfigurationorg.apache.velocity.tools.configNo description provided.
Configurationorg.apache.velocity.tools.configNo description provided.
ConfigurationCleanerorg.apache.velocity.tools.configNo description provided.
ConfigurationUtilsorg.apache.velocity.tools.configUtility methods for handling tool configurations.
ContextToolorg.apache.velocity.tools.view.toolsUse ContextTool
ContextToolorg.apache.velocity.tools.view

View tool for convenient access to ViewContext data and meta-data.

ConversionToolorg.apache.velocity.tools.generic

Utility class for easy conversion of String values to richer types.

ConversionUtilsorg.apache.velocity.toolsUtility methods for parsing or otherwise converting between types.
CookieToolorg.apache.velocity.tools.view

View tool for convenient cookie access and creation.

CookieToolorg.apache.velocity.tools.view.toolsUse CookieTool
Dataorg.apache.velocity.tools.configNo description provided.
Data.AutoConverterorg.apache.velocity.tools.configNo description provided.
Data.FieldConverterorg.apache.velocity.tools.configNo description provided.
Data.NumberConverterorg.apache.velocity.tools.configNo description provided.
DataInfoorg.apache.velocity.tools.view

ToolInfo implementation to handle "primitive" data types.

DateToolorg.apache.velocity.tools.genericTool for working with Date and Calendar in Velocity templates.
DisplayToolorg.apache.velocity.tools.genericProvides general utility methods for controlling the display of references.
DisplayTool.Measurementsorg.apache.velocity.tools.genericMeasures the dimensions of the string given to its constructor.
EasyFactoryConfigurationorg.apache.velocity.tools.config

FactoryConfiguration subclass that simplifies the process of configuration a ToolboxFactory in Java without the use of an xml or properties configuration file.

EasyFactoryConfiguration.EasyDataorg.apache.velocity.tools.configNo description provided.
EasyFactoryConfiguration.EasyWraporg.apache.velocity.tools.configNo description provided.
ErrorsToolorg.apache.velocity.tools.struts

This tool deals with Struts error messages.

EscapeToolorg.apache.velocity.tools.genericTool for working with escaping in Velocity templates.
FactoryConfigurationorg.apache.velocity.tools.config//TODO: add ability to log all this stuff and/or keep a running, ordered list of sources
FieldToolorg.apache.velocity.tools.generic

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.FieldToolSuborg.apache.velocity.tools.genericHolds a Map of results for a particular class.
FieldTool.MutableFieldorg.apache.velocity.tools.genericHolds a Field and Class reference for later retrieval of the value of a field that is not final and may change at different lookups.
FileFactoryConfigurationorg.apache.velocity.tools.configProvides support for reading a configuration file from a specified path, This frees the user from having to obtain an InputStream themselves.
FormatConfigorg.apache.velocity.tools.genericImplements common logic and constants for tools which allow their default format to be configured.
FormToolorg.apache.velocity.tools.struts

View tool to work with HTML forms in Struts.

ImportSupportorg.apache.velocity.tools.view

Provides methods to import arbitrary local or remote resources as strings.

ImportSupport.ImportResponseWrapperorg.apache.velocity.tools.viewWraps responses to allow us to retrieve results as Strings.
ImportSupport.SafeClosingHttpURLConnectionReaderorg.apache.velocity.tools.viewNo description provided.
ImportToolorg.apache.velocity.tools.viewGeneral-purpose text-importing view tool for templates.
ImportToolorg.apache.velocity.tools.view.toolsUse ImportTool
IteratorToolorg.apache.velocity.tools.generic

A convenience tool to use with #foreach loops.

JspToolContextorg.apache.velocity.tools.view.jsp

Velocity context implementation specific to the JSP environment.

LinkToolorg.apache.velocity.tools.view

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..
LinkToolorg.apache.velocity.tools.view.toolsUse LinkTool
LinkTool.QueryPairorg.apache.velocity.tools.viewInternal util class to handle representation and encoding of key/value pairs in the query string
ListToolorg.apache.velocity.tools.genericTool for working with Lists and arrays in Velocity templates.
LocaleConfigorg.apache.velocity.tools.genericImplements common logic and constants for tools which allow their default Locale to be configured.
LogChuteCommonsLogorg.apache.velocity.tools.generic.logRedirects commons-logging messages to Velocity's configured LogChute.
LogSupportorg.apache.velocity.tools.configThis allows for a Log to optionally be attached to a subclass in order to output logging messages.
LogSystemCommonsLogorg.apache.velocity.tools.generic.logRedirects commons-logging messages to Velocity's LogSystem.
LoopToolorg.apache.velocity.tools.generic

A convenience tool to use with #foreach loops.

LoopTool.ActionConditionorg.apache.velocity.tools.genericComposition class which associates an LoopTool.Action and LoopTool.ActionCondition for a LoopTool.ManagedIterator .
LoopTool.Comparisonorg.apache.velocity.tools.genericBase condition class for conditions (assumption here is that conditions are all comparative.
LoopTool.Equalsorg.apache.velocity.tools.genericSimple condition that checks elements in the iterator for equality to a specified Object.
LoopTool.ManagedIteratororg.apache.velocity.tools.genericIterator 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.
MarkupToolorg.apache.velocity.tools.generic

MarkupTool.Tagorg.apache.velocity.tools.genericNo description provided.
MathToolorg.apache.velocity.tools.generic

Tool for performing math in Velocity.

MessageResourcesToolorg.apache.velocity.tools.struts

Abstract view tool that provides access to Struts' message resources.

MessageToolorg.apache.velocity.tools.struts

The MessageTool is used to render internationalized message strings.

MessageTool.TextKeyorg.apache.velocity.tools.strutsHelper class to simplify tool usage when retrieving no-arg messages from the default bundle that have periods in their key.
MultiViewsToolorg.apache.velocity.tools.viewAllows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.
MultiViewsToolorg.apache.velocity.tools.view.i18nUse MultiViewsTool .
NumberToolorg.apache.velocity.tools.genericTool for working with Number in Velocity templates.
OldToolInfoorg.apache.velocity.toolsManages old tools which still use deprecated init() and configure() methods.
OldXmlFactoryConfigurationRuleSetorg.apache.velocity.tools.config

The set of Digester rules required to parse a old toolbox configuration file (toolbox.xml).

OldXmlFactoryConfigurationRuleSet.BooleanConfigRuleorg.apache.velocity.tools.configNo description provided.
OldXmlFactoryConfigurationRuleSet.CreateSessionRuleorg.apache.velocity.tools.configNo description provided.
OldXmlFactoryConfigurationRuleSet.DeprecationRuleorg.apache.velocity.tools.configNo description provided.
OldXmlFactoryConfigurationRuleSet.ParameterRuleorg.apache.velocity.tools.configNo description provided.
OldXmlFactoryConfigurationRuleSet.ScopeRuleorg.apache.velocity.tools.configNo description provided.
OldXmlFactoryConfigurationRuleSet.SetNextDataRuleorg.apache.velocity.tools.configNo description provided.
OldXmlFactoryConfigurationRuleSet.XhtmlRuleorg.apache.velocity.tools.configNo description provided.
PagerToolorg.apache.velocity.tools.view

View tool for doing request-based pagination of items in an a list.

ParameterParserorg.apache.velocity.tools.view.toolsUse ParameterTool
ParameterToolorg.apache.velocity.tools.view

Utility class for easy parsing of ServletRequest parameters.

PropertiesFactoryConfigurationorg.apache.velocity.tools.configNOTE: "property", "data", and "toolbox" are essentially reserved words do not use them as tool keys or toolbox scopes.
Propertyorg.apache.velocity.tools.configSimple extension of Data that treats "name" as an alias for "key".
RenderToolorg.apache.velocity.tools.genericThis tool exposes methods to evaluate the given strings as VTL (Velocity Template Language) using the given context.
ResourceToolorg.apache.velocity.tools.generic

Tool for accessing ResourceBundles and formatting messages therein.

ResourceTool.Keyorg.apache.velocity.tools.genericInternal class used to enable an elegant syntax for accessing resources.
Scopeorg.apache.velocity.toolsA specialized constants class to provide some compile-time typo checking and runtime validation for scopes specified in annotations, toolbox configs, etc.
SecureLinkToolorg.apache.velocity.tools.strutsTool to be able to use Struts SSL Extensions with Velocity.
ServletLogChuteorg.apache.velocity.tools.viewSimple wrapper for the servlet log.
ServletLoggerorg.apache.velocity.tools.view.servlet

This is basically an empty subclass of ServletLogChute that exists merely for backwards compatibility with VelocityTools 1.x.

ServletToolboxManagerorg.apache.velocity.tools.view.servlet

A toolbox manager for the servlet environment.

ServletToolboxRuleSetorg.apache.velocity.tools.view.servlet

The set of Digester rules required to parse a toolbox configuration file (toolbox.xml) for the ServletToolboxManager class.

ServletToolboxRuleSet.BooleanConfigRuleorg.apache.velocity.tools.view.servletAbstract rule for configuring boolean options on the parent object/element of the matching element.
ServletToolboxRuleSet.CreateSessionRuleorg.apache.velocity.tools.view.servletRule that sets setCreateSession() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
ServletToolboxRuleSet.XhtmlRuleorg.apache.velocity.tools.view.servletRule that sets setXhtml() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
ServletToolInfoorg.apache.velocity.tools.view.servlet

ToolInfo implementation that holds scope information for tools used in a servlet environment.

ServletUtilsorg.apache.velocity.tools.view

A set of utility methods for the servlet environment.

ServletUtilsorg.apache.velocity.tools.view.servletNo description provided.
SortToolorg.apache.velocity.tools.genericSortTool 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.PropertiesComparatororg.apache.velocity.tools.genericDoes all of the comparisons
StrutsLinkToolorg.apache.velocity.tools.struts

The StrutsLinkTool extends the standard LinkTool to add methods for working with Struts' Actions and Forwards:

StrutsUtilsorg.apache.velocity.tools.struts

A utility class to expose the Struts shared resources.

TilesToolorg.apache.velocity.tools.struts

The TilesTool is used to interact with the Struts-Tiles framework that is part of Struts 1.

Toolboxorg.apache.velocity.toolsNo description provided.
ToolboxConfigurationorg.apache.velocity.tools.configNo description provided.
ToolboxFactoryorg.apache.velocity.toolsNo description provided.
ToolboxRuleSetorg.apache.velocity.tools.view

The set of Digester rules required to parse a toolbox configuration file (toolbox.xml) for the XMLToolboxManager class.

ToolboxRuleSet.ParameterRuleorg.apache.velocity.tools.viewNo description provided.
ToolConfigurationorg.apache.velocity.tools.configNo description provided.
ToolContextorg.apache.velocity.toolsContext implementation that keeps a list of Toolbox es and returns them as requested, using its internal context Map as the dynamic properties passed to the requested tools when they are first created.
ToolInfoorg.apache.velocity.toolsManages data needed to create instances of a tool.
ToolManagerorg.apache.velocity.toolsManages tools for non-web applications.
ValidatorToolorg.apache.velocity.tools.struts

View tool that works with Struts Validator to produce client side javascript validation for your forms.

ValueParserorg.apache.velocity.tools.generic

Utility class for easy parsing of String values held in a Map.

VelocityLayoutServletorg.apache.velocity.tools.viewExtension of the VelocityViewServlet to perform "two-pass" layout rendering and allow for a customized error screen.
VelocityLayoutServletorg.apache.velocity.tools.view.servletNo description provided.
VelocityVieworg.apache.velocity.tools.view

The class provides the following features:

VelocityViewServletorg.apache.velocity.tools.view

A servlet to process Velocity templates.

VelocityViewServletorg.apache.velocity.tools.view.servletNo description provided.
VelocityViewTagorg.apache.velocity.tools.view.jsp

This tag enables use of Velocity and VelocityTools within JSP files and tags.

ViewRenderToolorg.apache.velocity.tools.viewThis tool expose methods to evaluate the given strings as VTL (Velocity Template Language) and automatically using the current context.
ViewRenderToolorg.apache.velocity.tools.view.toolsUse ViewRenderTool
ViewResourceToolorg.apache.velocity.tools.view

Tool for accessing ResourceBundles and formatting messages therein.

ViewResourceToolorg.apache.velocity.tools.view.toolsUse ViewResourceTool
ViewToolContextorg.apache.velocity.tools.view

Velocity context implementation specific to the Servlet environment.

ViewToolInfoorg.apache.velocity.tools.viewToolInfo implementation for view tools.
WebappLoaderorg.apache.velocity.tools.view.servlet

This is basically an empty subclass of WebappResourceLoader that exists merely for backwards compatibility with VelocityTools 1.x.

WebappResourceLoaderorg.apache.velocity.tools.viewResource loader that uses the ServletContext of a webapp to load Velocity templates.
XmlFactoryConfigurationorg.apache.velocity.tools.configNo description provided.
XmlFactoryConfigurationRuleSetorg.apache.velocity.tools.configNo description provided.
XmlFactoryConfigurationRuleSet.DataValueInBodyRuleorg.apache.velocity.tools.configRule for adding configuration properties
XmlFactoryConfigurationRuleSet.PropertyAttributeRuleorg.apache.velocity.tools.configNo description provided.
XMLToolboxManagerorg.apache.velocity.tools.viewA ToolboxManager for loading a toolbox from xml.
Search