| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_14) on Mon Apr 26 10:16:16 PDT 2010 --> | |
| <TITLE> | |
| org.apache.velocity.tools.generic (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic package"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="org.apache.velocity.tools.generic (VelocityTools 2.0 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/velocity/tools/config/package-summary.html"><B>PREV PACKAGE</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/log/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/package-summary.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <H2> | |
| Package org.apache.velocity.tools.generic | |
| </H2> | |
| Contains a collection of reusable, general-purpose "tools" for Velocity. | |
| <P> | |
| <B>See:</B> | |
| <BR> | |
| <A HREF="#package_description"><B>Description</B></A> | |
| <P> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Interface Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.Condition.html" title="interface in org.apache.velocity.tools.generic">LoopTool.Condition</A></B></TD> | |
| <TD>Represents a function into which a <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool.ManagedIterator</CODE></A> can | |
| pass it's next element to see if an <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.Action.html" title="enum in org.apache.velocity.tools.generic"><CODE>LoopTool.Action</CODE></A> should be taken.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Class Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/AbstractLockConfig.html" title="class in org.apache.velocity.tools.generic">AbstractLockConfig</A></B></TD> | |
| <TD><B>Deprecated.</B> <I>Use <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic"><CODE>SafeConfig</CODE></A> instead</I></TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></B></TD> | |
| <TD>Utility class for easily alternating over values in a list.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html" title="class in org.apache.velocity.tools.generic">AlternatorTool</A></B></TD> | |
| <TD>Simple tool to provide easy in-template instantiation of | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A>s from varying "list" types or individual | |
| arguments.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.html" title="class in org.apache.velocity.tools.generic">ClassTool</A></B></TD> | |
| <TD> | |
| This tool is meant to simplify reflective lookup of information about | |
| a <CODE>Class</CODE> and its <CODE>Field</CODE>s, <CODE>Method</CODE>s, and <CODE>Constructor</CODE>s.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.CallableSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.CallableSub<T extends ClassTool.CallableSub></A></B></TD> | |
| <TD> </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.ConstructorSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.ConstructorSub</A></B></TD> | |
| <TD>A simplified wrapping interface for inspecting features | |
| of a <CODE>Constructor</CODE> in an inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.FieldSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.FieldSub</A></B></TD> | |
| <TD>A simplified wrapping interface for inspecting features | |
| of a <CODE>Field</CODE> in an inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.MethodSub.html" title="class in org.apache.velocity.tools.generic">ClassTool.MethodSub</A></B></TD> | |
| <TD>A simplified wrapping interface for inspecting features | |
| of a <CODE>Method</CODE> in an inspected Class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ClassTool.Sub.html" title="class in org.apache.velocity.tools.generic">ClassTool.Sub<T extends ClassTool.Sub></A></B></TD> | |
| <TD> </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool</A></B></TD> | |
| <TD>Tool for comparing <CODE>Date</CODE> and <CODE>Calendar</CODE> values | |
| in Velocity templates.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ContextTool.html" title="class in org.apache.velocity.tools.generic">ContextTool</A></B></TD> | |
| <TD>Tool for convenient access to <CODE>Context</CODE> data and | |
| meta-data.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ConversionTool.html" title="class in org.apache.velocity.tools.generic">ConversionTool</A></B></TD> | |
| <TD>Utility class for easy conversion of String values to richer types.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html" title="class in org.apache.velocity.tools.generic">DateTool</A></B></TD> | |
| <TD>Tool for working with <CODE>Date</CODE> and <CODE>Calendar</CODE> | |
| in Velocity templates.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html" title="class in org.apache.velocity.tools.generic">DisplayTool</A></B></TD> | |
| <TD>Provides general utility methods for controlling the display of references.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic">DisplayTool.Measurements</A></B></TD> | |
| <TD>Measures the dimensions of the string given to its constructor.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.html" title="class in org.apache.velocity.tools.generic">EscapeTool</A></B></TD> | |
| <TD>Tool for working with escaping in Velocity templates.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/FieldTool.html" title="class in org.apache.velocity.tools.generic">FieldTool</A></B></TD> | |
| <TD> | |
| This is a simple tools class to allow easy access to static fields in a class, | |
| such as string constants from within a template.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/FieldTool.FieldToolSub.html" title="class in org.apache.velocity.tools.generic">FieldTool.FieldToolSub</A></B></TD> | |
| <TD>Holds a <CODE>Map</CODE> of results for a particular class.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/FieldTool.MutableField.html" title="class in org.apache.velocity.tools.generic">FieldTool.MutableField</A></B></TD> | |
| <TD>Holds a <CODE>Field</CODE> and <CODE>Class</CODE> reference for later | |
| retrieval of the value of a field that is not final and may | |
| change at different lookups.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/FormatConfig.html" title="class in org.apache.velocity.tools.generic">FormatConfig</A></B></TD> | |
| <TD>Implements common logic and constants for tools which allow their | |
| default format to be configured.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.html" title="class in org.apache.velocity.tools.generic">IteratorTool</A></B></TD> | |
| <TD><B>Deprecated.</B> <I>Use <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool</CODE></A> instead</I></TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</A></B></TD> | |
| <TD>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.. | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html" title="class in org.apache.velocity.tools.generic">ListTool</A></B></TD> | |
| <TD><B>Deprecated.</B></TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></B></TD> | |
| <TD>Implements common logic and constants for tools which allow their | |
| default <CODE>Locale</CODE> to be configured.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.html" title="class in org.apache.velocity.tools.generic">LoopTool</A></B></TD> | |
| <TD> | |
| A convenience tool to use with #foreach loops.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ActionCondition.html" title="class in org.apache.velocity.tools.generic">LoopTool.ActionCondition</A></B></TD> | |
| <TD>Composition class which associates an <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.Action.html" title="enum in org.apache.velocity.tools.generic"><CODE>LoopTool.Action</CODE></A> and <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ActionCondition.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool.ActionCondition</CODE></A> | |
| for a <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool.ManagedIterator</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.Comparison.html" title="class in org.apache.velocity.tools.generic">LoopTool.Comparison</A></B></TD> | |
| <TD>Base condition class for conditions (assumption here is that | |
| conditions are all comparative.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.Equals.html" title="class in org.apache.velocity.tools.generic">LoopTool.Equals</A></B></TD> | |
| <TD>Simple condition that checks elements in the iterator | |
| for equality to a specified Object.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</A></B></TD> | |
| <TD>Iterator implementation that wraps a standard <CODE>Iterator</CODE> | |
| and allows it to be prematurely stopped, skipped ahead, and | |
| associated with a name for advanced nested loop control.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.SyncedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.SyncedIterator</A></B></TD> | |
| <TD>Simple wrapper to make it easy to keep an arbitray Iterator | |
| in sync with a <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool.ManagedIterator</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/MarkupTool.html" title="class in org.apache.velocity.tools.generic">MarkupTool</A></B></TD> | |
| <TD><b>NOTE: This tools is considered "alpha" quality due to lack of testing | |
| and a generally unpolished API.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/MarkupTool.Tag.html" title="class in org.apache.velocity.tools.generic">MarkupTool.Tag</A></B></TD> | |
| <TD> </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/MathTool.html" title="class in org.apache.velocity.tools.generic">MathTool</A></B></TD> | |
| <TD>Tool for performing math in Velocity.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html" title="class in org.apache.velocity.tools.generic">NumberTool</A></B></TD> | |
| <TD>Tool for working with <CODE>Number</CODE> in Velocity templates.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A></B></TD> | |
| <TD>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.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ResourceTool.html" title="class in org.apache.velocity.tools.generic">ResourceTool</A></B></TD> | |
| <TD>Tool for accessing ResourceBundles and formatting messages therein.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TD> | |
| <TD>Implements common logic and constants for tools which automatically | |
| locks down the <code>public void configure(Map params)</code> method after | |
| it is called once.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.html" title="class in org.apache.velocity.tools.generic">SortTool</A></B></TD> | |
| <TD>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.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html" title="class in org.apache.velocity.tools.generic">SortTool.PropertiesComparator</A></B></TD> | |
| <TD>Does all of the comparisons</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></B></TD> | |
| <TD>Utility class for easy parsing of String values held in a Map.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/XmlTool.html" title="class in org.apache.velocity.tools.generic">XmlTool</A></B></TD> | |
| <TD>Tool for reading/navigating XML files.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/XmlTool.NodeIterator.html" title="class in org.apache.velocity.tools.generic">XmlTool.NodeIterator</A></B></TD> | |
| <TD>Iterator implementation that wraps a Node list iterator | |
| to return new XmlTool instances for each item in the wrapped | |
| iterator.s</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Enum Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.Action.html" title="enum in org.apache.velocity.tools.generic">LoopTool.Action</A></B></TD> | |
| <TD>Represents an automatic action taken by a <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool.ManagedIterator</CODE></A> | |
| when a <A HREF="../../../../../org/apache/velocity/tools/generic/LoopTool.ActionCondition.html" title="class in org.apache.velocity.tools.generic"><CODE>LoopTool.ActionCondition</CODE></A> is satisfied by the subsequent element.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../org/apache/velocity/tools/generic/MarkupTool.Mode.html" title="enum in org.apache.velocity.tools.generic">MarkupTool.Mode</A></B></TD> | |
| <TD> </TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <A NAME="package_description"><!-- --></A><H2> | |
| Package org.apache.velocity.tools.generic Description | |
| </H2> | |
| <P> | |
| Contains a collection of reusable, general-purpose "tools" for Velocity. | |
| These tools are independent of the VelocityView classes and may be used | |
| in any context. | |
| <!-- | |
| ##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. ##### | |
| ##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A ##### | |
| ##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: ##### | |
| Provides for.... | |
| --> | |
| <h2>Package Specification</h2> | |
| <!-- | |
| ##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT ##### | |
| <ul> | |
| <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a> | |
| </ul> | |
| --> | |
| <h2>Related Documentation</h2> | |
| <!-- | |
| For overviews, tutorials, examples, guides, and tool documentation, please see: | |
| <ul> | |
| <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a> | |
| </ul> | |
| --> | |
| <!-- Put @see and @since tags down here. --> | |
| <P> | |
| <P> | |
| <DL> | |
| </DL> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/velocity/tools/config/package-summary.html"><B>PREV PACKAGE</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/generic/log/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/package-summary.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |