| |
| |
| <html> |
| <head> |
| <title>Velocity - GenericTools</title> |
| |
| <meta name="author" value="Gabriel Sidler"/> |
| <meta name="email" value="sidler@apache.org" /> |
| |
| |
| </head> |
| |
| <body bgcolor="#ffffff" text="#000000" link="#525D76" |
| alink="#525D76" vlink="#525D76"> |
| |
| <table border="0" width="100%" cellspacing="4"> |
| |
| <tr><td colspan="2"> |
| |
| <a href="http://jakarta.apache.org/"> |
| <img src="http://jakarta.apache.org/images/jakarta-logo.gif" |
| align="left" alt="The Jakarta Project" border="0"/> |
| </a> |
| |
| |
| |
| <a href="index.html"> |
| <img src="../images/velocitygenerictools.png" align="right" alt="< Velocity Tools - Library >" border="0"/> |
| </a> |
| |
| </td></tr> |
| |
| <tr> |
| <td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td> |
| </tr> |
| |
| <tr> |
| |
| <td width="20%" valign="top" nowrap="true"> |
| |
| <p><strong><a href="../">Velocity Tools</a></strong></p> |
| |
| <p> |
| <strong>Generic Tools</strong> |
| </p> |
| <ul> |
| <li><a href="index.html">Overview</a></li> |
| <li><a href="../index.html#Download">Download</a></li> |
| <li><a href="index.html#Contributions">Contributions</a></li> |
| <li><a href="../javadoc/index.html">Javadoc</a></li> |
| |
| </ul> |
| <p> |
| <strong>Tool Documentation</strong> |
| </p> |
| <ul> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/DateTool.html">DateTool</a></li> |
| <li><a href="MathTool.html">MathTool</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/NumberTool.html">NumberTool</a></li> |
| <li><a href="RenderTool.html">RenderTool</a></li> |
| <li><a href="EscapeTool.html">EscapeTool</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/ResourceTool.html">ResourceTool</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/Alternator.html">Alternator</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/AlternatorTool.html">AlternatorTool</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/ValueParser.html">ValueParser</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/ListTool.html">ListTool</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/SortTool.html">SortTool</a></li> |
| <li><a href="../javadoc/org/apache/velocity/tools/generic/IteratorTool.html">IteratorTool</a></li> |
| |
| </ul> |
| <p> |
| <strong>Other Subprojects</strong> |
| </p> |
| <ul> |
| <li><a href="../view/">VelocityView</a></li> |
| <li><a href="../struts/">VelocityStruts</a></li> |
| |
| </ul> |
| |
| <p> |
| </p> |
| |
| </td> |
| |
| <!-- RIGHT SIDE MAIN BODY --> |
| <td colspan="1" valign="top" align="left"> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#525D76"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Overview"> |
| <strong>Overview</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p> |
| GenericTools contains a collection of reusable and well |
| documented tools and utility classes of general interest |
| to Velocity users. These classes and tools have no dependency |
| on the VelocityView or VelocityStruts sub-projects. The tools may |
| be used as you would any other POJO ("plain old java object"). |
| </p> |
| <p> |
| <strong>Tools:</strong> |
| <dl> |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/DateTool.html"><strong>DateTool</strong></a></dt> |
| <dd>A tool for manipulating and formatting dates.</dd> |
| |
| <dt><a href="MathTool.html"><strong>MathTool</strong></a></dt> |
| <dd>A tool for performing floating point math.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/NumberTool.html"><strong>NumberTool</strong></a></dt> |
| <dd>A tool for formatting numbers.</dd> |
| |
| <dt><a href="RenderTool.html"><strong>RenderTool</strong></a></dt> |
| <dd>A tool to evaluate and render arbitrary strings of VTL (Velocity |
| Template Language).</dd> |
| |
| <dt><a href="EscapeTool.html"><strong>EscapeTool</strong></a></dt> |
| <dd>A tool to help with common escaping needs in Velocity templates.</dd> |
| |
| <dt><a |
| href="../javadoc/org/apache/velocity/tools/generic/ResourceTool.html"><strong>ResourceTool</strong></a></dt> |
| <dd>A tool to simplify access to ResourceBundles for internationalization or other dynamic content needs.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/Alternator.html"><strong>Alternator</strong></a> |
| and <a href="../javadoc/org/apache/velocity/tools/generic/AlternatorTool.html"><strong>AlternatorTool</strong></a></dt> |
| <dd>Utility class for easily alternating over values in a list and tool for easy creation of Alternators in templates.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/ValueParser.html"><strong>ValueParser</strong></a></dt> |
| <dd>A tool to retrieve and parse String values pulled from a map. This provides |
| the basis for the <a href="../view/ParameterParser.html">ParameterParser</a> in |
| <a href="../view/index.html">VelocityView</a>.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/ListTool.html"><strong>ListTool</strong></a></dt> |
| <dd>A tool to help when working with arrays or Lists. This tool transparently handles both the same way.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/SortTool.html"><strong>SortTool</strong></a></dt> |
| <dd>A tool that 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.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/IteratorTool.html"><strong>IteratorTool</strong></a></dt> |
| <dd>A convenience tool to use with #foreach loops. It wraps a list |
| to let the designer specify a condition to terminate the loop, |
| and reuse the same list in different loops.</dd> |
| </dl> |
| <br clear="all"/> |
| <strong>Utilities:</strong> |
| <dl> |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/log/CommonsLogLogSystem.html"><strong>CommonsLogLogSystem</strong></a></dt> |
| <dd>An implementation of Velocity's LogSystem interface that redirects |
| log output to a Commons-Logging Log instance.</dd> |
| |
| <dt><a href="../javadoc/org/apache/velocity/tools/generic/log/LogSystemCommonsLog.html"><strong>LogSystemCommonsLog</strong></a></dt> |
| <dd>An implementation of Commons-Logging's Log interface that redirects |
| log output to Velocity's LogSystem.</dd> |
| </dl> |
| </p> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#525D76"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Contributions"> |
| <strong>Contributions</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p>We welcome your contributions to this library. Patches can be sent to the |
| mailing list or attached to a |
| <a href="http://issues.apache.org/jira/browse/VELTOOLS">JIRA</a> |
| issue. The <a href="http://wiki.apache.org/velocity/VelocityTools">Wiki</a> |
| can also be a good place to discuss and develop ideas.</p> |
| <p><strong>Checklist for Contributions</strong></p> |
| <ul> |
| <li><a href="http://wiki.apache.org/velocity/CodeStandards">Velocity coding conventions</a></li> |
| <li>JavaDoc included (the more detailed the better)</li> |
| <li>Examples included (in JavaDoc or as stand-alone template example)</li> |
| </ul> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| |
| </tr> |
| |
| <!-- FOOTER SEPARATOR --> |
| <tr> |
| <td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td> |
| </tr> |
| |
| <!-- PAGE FOOTER --> |
| <tr><td colspan="2"> |
| <div align="center"><font color="#525D76" size="-1"><em> |
| Copyright © 1999-2003, Apache Software Foundation |
| </em></font></div> |
| </td></tr> |
| |
| </table> |
| </body> |
| </html> |
