Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html?view=diff&rev=477914&r1=477913&r2=477914 ============================================================================== --- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html (original) +++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html Tue Nov 21 13:52:11 2006 @@ -1,547 +1,547 @@ -<!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_02) on Thu Oct 20 10:35:34 PDT 2005 --> -<TITLE> -ListTool (Velocity Tools 1.2 Documentation) -</TITLE> - -<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.ListTool class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="ListTool (Velocity Tools 1.2 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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/generic/IteratorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> - <A HREF="../../../../../org/apache/velocity/tools/generic/MathTool.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ListTool.html" target="_top"><B>FRAMES</B></A> - <A HREF="ListTool.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> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.apache.velocity.tools.generic</FONT> -<BR> -Class ListTool</H2> -<PRE> -java.lang.Object - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.ListTool</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>ListTool</B><DT>extends java.lang.Object</DL> -</PRE> - -<P> -Tool for working with Lists and arrays in Velocity templates. - It provides a method to get and set specified elements. - Also provides methods to perform the following actions to Lists and arrays: - <ul> - <li>Check if it is empty.</li> - <li>Check if it contains a certain element.</li> - </ul> - - <p><pre> - Example uses: - $primes -> new int[] {2, 3, 5, 7} - $list.size($primes) -> 4 - $list.get($primes, 2) -> 5 - $list.set($primes, 2, 1) -> (primes[2] becomes 1) - $list.get($primes, 2) -> 1 - $list.isEmpty($primes) -> false - $list.contains($primes, 7) -> true - - Example toolbox.xml config (if you want to use this with VelocityView): - <tool> - <key>list</key> - <scope>application</scope> - <class>org.apache.velocity.tools.generic.ListTool</class> - </tool> - </pre></p> - - <p>This tool is entirely threadsafe, and has no instance members. - It may be used in any scope (request, session, or application). - </p> -<P> - -<P> -<DL> -<DT><B>Since:</B></DT> - <DD>VelocityTools 1.2</DD> -<DT><B>Version:</B></DT> - <DD>$Id: $</DD> -<DT><B>Author:</B></DT> - <DD><a href="mailto:[EMAIL PROTECTED]">Shinobu Kawai</a></DD> -</DL> -<HR> - -<P> - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#ListTool()">ListTool</A></B>()</CODE> - -<BR> - Default constructor.</TD> -</TR> -</TABLE> - -<!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>private java.lang.Boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#arrayContains(java.lang.Object, java.lang.Object)">arrayContains</A></B>(java.lang.Object array, - java.lang.Object element)</CODE> - -<BR> - Checks if an array contains a certain element.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.Boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#contains(java.lang.Object, java.lang.Object)">contains</A></B>(java.lang.Object list, - java.lang.Object element)</CODE> - -<BR> - Checks if a List/array contains a certain element.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>private boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#equals(java.lang.Object, java.lang.Object)">equals</A></B>(java.lang.Object what, - java.lang.Object with)</CODE> - -<BR> - Check if two objects are equal.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.Object</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#get(java.lang.Object, int)">get</A></B>(java.lang.Object list, - int index)</CODE> - -<BR> - Gets the specified element of a List/array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>private java.lang.Object</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#getFromArray(java.lang.Object, int)">getFromArray</A></B>(java.lang.Object array, - int index)</CODE> - -<BR> - Gets the specified element of an array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#isArray(java.lang.Object)">isArray</A></B>(java.lang.Object object)</CODE> - -<BR> - Checks if an object is an array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.Boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#isEmpty(java.lang.Object)">isEmpty</A></B>(java.lang.Object list)</CODE> - -<BR> - Checks if a List/array is empty.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#isList(java.lang.Object)">isList</A></B>(java.lang.Object object)</CODE> - -<BR> - Checks if an object is a List.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.Object</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#set(java.lang.Object, int, java.lang.Object)">set</A></B>(java.lang.Object list, - int index, - java.lang.Object value)</CODE> - -<BR> - Sets the specified element of a List/array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>private java.lang.Object</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#setToArray(java.lang.Object, int, java.lang.Object)">setToArray</A></B>(java.lang.Object array, - int index, - java.lang.Object value)</CODE> - -<BR> - Sets the specified element of an array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.Integer</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#size(java.lang.Object)">size</A></B>(java.lang.Object list)</CODE> - -<BR> - Gets the size of a List/array.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="ListTool()"><!-- --></A><H3> -ListTool</H3> -<PRE> -public <B>ListTool</B>()</PRE> -<DL> -<DD>Default constructor. -<P> -</DL> - -<!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="get(java.lang.Object, int)"><!-- --></A><H3> -get</H3> -<PRE> -public java.lang.Object <B>get</B>(java.lang.Object list, - int index)</PRE> -<DL> -<DD>Gets the specified element of a List/array. - It will return null under the following conditions: - <ul> - <li><code>list</code> is null.</li> - <li><code>list</code> is not a List/array.</li> - <li><code>list</code> doesn't have an <code>index</code>th value.</li> - </ul> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array object.<DD><CODE>index</CODE> - the index of the List/array to get. -<DT><B>Returns:</B><DD>the specified element of the List/array.</DL> -</DD> -</DL> -<HR> - -<A NAME="getFromArray(java.lang.Object, int)"><!-- --></A><H3> -getFromArray</H3> -<PRE> -private java.lang.Object <B>getFromArray</B>(java.lang.Object array, - int index)</PRE> -<DL> -<DD>Gets the specified element of an array. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>array</CODE> - the array object.<DD><CODE>index</CODE> - the index of the array to get. -<DT><B>Returns:</B><DD>the specified element of the array.</DL> -</DD> -</DL> -<HR> - -<A NAME="set(java.lang.Object, int, java.lang.Object)"><!-- --></A><H3> -set</H3> -<PRE> -public java.lang.Object <B>set</B>(java.lang.Object list, - int index, - java.lang.Object value)</PRE> -<DL> -<DD>Sets the specified element of a List/array. - It will return null under the following conditions: - <ul> - <li><code>list</code> is null.</li> - <li><code>list</code> is not a List/array.</li> - <li><code>list</code> doesn't have an <code>index</code>th value.</li> - </ul> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array object.<DD><CODE>index</CODE> - the index of the List/array to set.<DD><CODE>value</CODE> - the element to set. -<DT><B>Returns:</B><DD>blank if set, null if not set.</DL> -</DD> -</DL> -<HR> - -<A NAME="setToArray(java.lang.Object, int, java.lang.Object)"><!-- --></A><H3> -setToArray</H3> -<PRE> -private java.lang.Object <B>setToArray</B>(java.lang.Object array, - int index, - java.lang.Object value)</PRE> -<DL> -<DD>Sets the specified element of an array. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>array</CODE> - the array object.<DD><CODE>index</CODE> - the index of the array to set.<DD><CODE>value</CODE> - the element to set. -<DT><B>Returns:</B><DD>blank if set, null if not set.</DL> -</DD> -</DL> -<HR> - -<A NAME="size(java.lang.Object)"><!-- --></A><H3> -size</H3> -<PRE> -public java.lang.Integer <B>size</B>(java.lang.Object list)</PRE> -<DL> -<DD>Gets the size of a List/array. - It will return null under the following conditions: - <ul> - <li><code>list</code> is null.</li> - <li><code>list</code> is not a List/array.</li> - </ul> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List object. -<DT><B>Returns:</B><DD>the size of the List.</DL> -</DD> -</DL> -<HR> - -<A NAME="isArray(java.lang.Object)"><!-- --></A><H3> -isArray</H3> -<PRE> -public boolean <B>isArray</B>(java.lang.Object object)</PRE> -<DL> -<DD>Checks if an object is an array. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to check. -<DT><B>Returns:</B><DD><code>true</code> if the object is an array.</DL> -</DD> -</DL> -<HR> - -<A NAME="isList(java.lang.Object)"><!-- --></A><H3> -isList</H3> -<PRE> -public boolean <B>isList</B>(java.lang.Object object)</PRE> -<DL> -<DD>Checks if an object is a List. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to check. -<DT><B>Returns:</B><DD><code>true</code> if the object is a List.</DL> -</DD> -</DL> -<HR> - -<A NAME="isEmpty(java.lang.Object)"><!-- --></A><H3> -isEmpty</H3> -<PRE> -public java.lang.Boolean <B>isEmpty</B>(java.lang.Object list)</PRE> -<DL> -<DD>Checks if a List/array is empty. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array to check. -<DT><B>Returns:</B><DD><code>true</code> if the List/array is empty.</DL> -</DD> -</DL> -<HR> - -<A NAME="contains(java.lang.Object, java.lang.Object)"><!-- --></A><H3> -contains</H3> -<PRE> -public java.lang.Boolean <B>contains</B>(java.lang.Object list, - java.lang.Object element)</PRE> -<DL> -<DD>Checks if a List/array contains a certain element. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array to check.<DD><CODE>element</CODE> - the element to check. -<DT><B>Returns:</B><DD><code>true</code> if the List/array contains the element.</DL> -</DD> -</DL> -<HR> - -<A NAME="arrayContains(java.lang.Object, java.lang.Object)"><!-- --></A><H3> -arrayContains</H3> -<PRE> -private java.lang.Boolean <B>arrayContains</B>(java.lang.Object array, - java.lang.Object element)</PRE> -<DL> -<DD>Checks if an array contains a certain element. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to check.<DD><CODE>element</CODE> - the element to check. -<DT><B>Returns:</B><DD><code>true</code> if the array contains the element.</DL> -</DD> -</DL> -<HR> - -<A NAME="equals(java.lang.Object, java.lang.Object)"><!-- --></A><H3> -equals</H3> -<PRE> -private boolean <B>equals</B>(java.lang.Object what, - java.lang.Object with)</PRE> -<DL> -<DD>Check if two objects are equal. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>what</CODE> - an object<DD><CODE>with</CODE> - another object. -<DT><B>Returns:</B><DD><code>true</code> if the two objects are equal.</DL> -</DD> -</DL> -<!-- ========= END OF CLASS DATA ========= --> -<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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/generic/IteratorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> - <A HREF="../../../../../org/apache/velocity/tools/generic/MathTool.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ListTool.html" target="_top"><B>FRAMES</B></A> - <A HREF="ListTool.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> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -Copyright (c) 2003 Apache Software Foundation -</BODY> -</HTML> +<!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_09) on Tue Nov 21 22:45:25 CET 2006 --> +<TITLE> +ListTool (Velocity Tools 1.3-dev Documentation) +</TITLE> + +<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.ListTool class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ListTool (Velocity Tools 1.3-dev 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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/generic/IteratorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/velocity/tools/generic/MathTool.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ListTool.html" target="_top"><B>FRAMES</B></A> + <A HREF="ListTool.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> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.velocity.tools.generic</FONT> +<BR> +Class ListTool</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.ListTool</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>ListTool</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Tool for working with Lists and arrays in Velocity templates. + It provides a method to get and set specified elements. + Also provides methods to perform the following actions to Lists and arrays: + <ul> + <li>Check if it is empty.</li> + <li>Check if it contains a certain element.</li> + </ul> + + <p><pre> + Example uses: + $primes -> new int[] {2, 3, 5, 7} + $list.size($primes) -> 4 + $list.get($primes, 2) -> 5 + $list.set($primes, 2, 1) -> (primes[2] becomes 1) + $list.get($primes, 2) -> 1 + $list.isEmpty($primes) -> false + $list.contains($primes, 7) -> true + + Example toolbox.xml config (if you want to use this with VelocityView): + <tool> + <key>list</key> + <scope>application</scope> + <class>org.apache.velocity.tools.generic.ListTool</class> + </tool> + </pre></p> + + <p>This tool is entirely threadsafe, and has no instance members. + It may be used in any scope (request, session, or application). + </p> +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>VelocityTools 1.2</DD> +<DT><B>Version:</B></DT> + <DD>$Id: $</DD> +<DT><B>Author:</B></DT> + <DD><a href="mailto:[EMAIL PROTECTED]">Shinobu Kawai</a></DD> +</DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#ListTool()">ListTool</A></B>()</CODE> + +<BR> + Default constructor.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>private java.lang.Boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#arrayContains(java.lang.Object, java.lang.Object)">arrayContains</A></B>(java.lang.Object array, + java.lang.Object element)</CODE> + +<BR> + Checks if an array contains a certain element.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#contains(java.lang.Object, java.lang.Object)">contains</A></B>(java.lang.Object list, + java.lang.Object element)</CODE> + +<BR> + Checks if a List/array contains a certain element.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>private boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#equals(java.lang.Object, java.lang.Object)">equals</A></B>(java.lang.Object what, + java.lang.Object with)</CODE> + +<BR> + Check if two objects are equal.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#get(java.lang.Object, int)">get</A></B>(java.lang.Object list, + int index)</CODE> + +<BR> + Gets the specified element of a List/array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>private java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#getFromArray(java.lang.Object, int)">getFromArray</A></B>(java.lang.Object array, + int index)</CODE> + +<BR> + Gets the specified element of an array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#isArray(java.lang.Object)">isArray</A></B>(java.lang.Object object)</CODE> + +<BR> + Checks if an object is an array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#isEmpty(java.lang.Object)">isEmpty</A></B>(java.lang.Object list)</CODE> + +<BR> + Checks if a List/array is empty.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#isList(java.lang.Object)">isList</A></B>(java.lang.Object object)</CODE> + +<BR> + Checks if an object is a List.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#set(java.lang.Object, int, java.lang.Object)">set</A></B>(java.lang.Object list, + int index, + java.lang.Object value)</CODE> + +<BR> + Sets the specified element of a List/array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>private java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#setToArray(java.lang.Object, int, java.lang.Object)">setToArray</A></B>(java.lang.Object array, + int index, + java.lang.Object value)</CODE> + +<BR> + Sets the specified element of an array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Integer</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ListTool.html#size(java.lang.Object)">size</A></B>(java.lang.Object list)</CODE> + +<BR> + Gets the size of a List/array.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ListTool()"><!-- --></A><H3> +ListTool</H3> +<PRE> +public <B>ListTool</B>()</PRE> +<DL> +<DD>Default constructor. +<P> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="get(java.lang.Object, int)"><!-- --></A><H3> +get</H3> +<PRE> +public java.lang.Object <B>get</B>(java.lang.Object list, + int index)</PRE> +<DL> +<DD>Gets the specified element of a List/array. + It will return null under the following conditions: + <ul> + <li><code>list</code> is null.</li> + <li><code>list</code> is not a List/array.</li> + <li><code>list</code> doesn't have an <code>index</code>th value.</li> + </ul> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array object.<DD><CODE>index</CODE> - the index of the List/array to get. +<DT><B>Returns:</B><DD>the specified element of the List/array.</DL> +</DD> +</DL> +<HR> + +<A NAME="getFromArray(java.lang.Object, int)"><!-- --></A><H3> +getFromArray</H3> +<PRE> +private java.lang.Object <B>getFromArray</B>(java.lang.Object array, + int index)</PRE> +<DL> +<DD>Gets the specified element of an array. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>array</CODE> - the array object.<DD><CODE>index</CODE> - the index of the array to get. +<DT><B>Returns:</B><DD>the specified element of the array.</DL> +</DD> +</DL> +<HR> + +<A NAME="set(java.lang.Object, int, java.lang.Object)"><!-- --></A><H3> +set</H3> +<PRE> +public java.lang.Object <B>set</B>(java.lang.Object list, + int index, + java.lang.Object value)</PRE> +<DL> +<DD>Sets the specified element of a List/array. + It will return null under the following conditions: + <ul> + <li><code>list</code> is null.</li> + <li><code>list</code> is not a List/array.</li> + <li><code>list</code> doesn't have an <code>index</code>th value.</li> + </ul> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array object.<DD><CODE>index</CODE> - the index of the List/array to set.<DD><CODE>value</CODE> - the element to set. +<DT><B>Returns:</B><DD>blank if set, null if not set.</DL> +</DD> +</DL> +<HR> + +<A NAME="setToArray(java.lang.Object, int, java.lang.Object)"><!-- --></A><H3> +setToArray</H3> +<PRE> +private java.lang.Object <B>setToArray</B>(java.lang.Object array, + int index, + java.lang.Object value)</PRE> +<DL> +<DD>Sets the specified element of an array. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>array</CODE> - the array object.<DD><CODE>index</CODE> - the index of the array to set.<DD><CODE>value</CODE> - the element to set. +<DT><B>Returns:</B><DD>blank if set, null if not set.</DL> +</DD> +</DL> +<HR> + +<A NAME="size(java.lang.Object)"><!-- --></A><H3> +size</H3> +<PRE> +public java.lang.Integer <B>size</B>(java.lang.Object list)</PRE> +<DL> +<DD>Gets the size of a List/array. + It will return null under the following conditions: + <ul> + <li><code>list</code> is null.</li> + <li><code>list</code> is not a List/array.</li> + </ul> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List object. +<DT><B>Returns:</B><DD>the size of the List.</DL> +</DD> +</DL> +<HR> + +<A NAME="isArray(java.lang.Object)"><!-- --></A><H3> +isArray</H3> +<PRE> +public boolean <B>isArray</B>(java.lang.Object object)</PRE> +<DL> +<DD>Checks if an object is an array. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to check. +<DT><B>Returns:</B><DD><code>true</code> if the object is an array.</DL> +</DD> +</DL> +<HR> + +<A NAME="isList(java.lang.Object)"><!-- --></A><H3> +isList</H3> +<PRE> +public boolean <B>isList</B>(java.lang.Object object)</PRE> +<DL> +<DD>Checks if an object is a List. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to check. +<DT><B>Returns:</B><DD><code>true</code> if the object is a List.</DL> +</DD> +</DL> +<HR> + +<A NAME="isEmpty(java.lang.Object)"><!-- --></A><H3> +isEmpty</H3> +<PRE> +public java.lang.Boolean <B>isEmpty</B>(java.lang.Object list)</PRE> +<DL> +<DD>Checks if a List/array is empty. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array to check. +<DT><B>Returns:</B><DD><code>true</code> if the List/array is empty.</DL> +</DD> +</DL> +<HR> + +<A NAME="contains(java.lang.Object, java.lang.Object)"><!-- --></A><H3> +contains</H3> +<PRE> +public java.lang.Boolean <B>contains</B>(java.lang.Object list, + java.lang.Object element)</PRE> +<DL> +<DD>Checks if a List/array contains a certain element. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>list</CODE> - the List/array to check.<DD><CODE>element</CODE> - the element to check. +<DT><B>Returns:</B><DD><code>true</code> if the List/array contains the element.</DL> +</DD> +</DL> +<HR> + +<A NAME="arrayContains(java.lang.Object, java.lang.Object)"><!-- --></A><H3> +arrayContains</H3> +<PRE> +private java.lang.Boolean <B>arrayContains</B>(java.lang.Object array, + java.lang.Object element)</PRE> +<DL> +<DD>Checks if an array contains a certain element. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to check.<DD><CODE>element</CODE> - the element to check. +<DT><B>Returns:</B><DD><code>true</code> if the array contains the element.</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(java.lang.Object, java.lang.Object)"><!-- --></A><H3> +equals</H3> +<PRE> +private boolean <B>equals</B>(java.lang.Object what, + java.lang.Object with)</PRE> +<DL> +<DD>Check if two objects are equal. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>what</CODE> - an object<DD><CODE>with</CODE> - another object. +<DT><B>Returns:</B><DD><code>true</code> if the two objects are equal.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/generic/IteratorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/velocity/tools/generic/MathTool.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/ListTool.html" target="_top"><B>FRAMES</B></A> + <A HREF="ListTool.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> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright (c) 2003-2006 Apache Software Foundation +</BODY> +</HTML>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html?view=diff&rev=477914&r1=477913&r2=477914 ============================================================================== --- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html (original) +++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html Tue Nov 21 13:52:11 2006 @@ -2,9 +2,9 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 --> +<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 --> <TITLE> -MathTool (Velocity Tools 1.2 Documentation) +MathTool (Velocity Tools 1.3-dev Documentation) </TITLE> <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.MathTool class"> @@ -14,7 +14,7 @@ <SCRIPT type="text/javascript"> function windowTitle() { - parent.document.title="MathTool (Velocity Tools 1.2 Documentation)"; + parent.document.title="MathTool (Velocity Tools 1.3-dev Documentation)"; } </SCRIPT> <NOSCRIPT> @@ -1079,6 +1079,6 @@ <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> -Copyright (c) 2003 Apache Software Foundation +Copyright (c) 2003-2006 Apache Software Foundation </BODY> </HTML> Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html?view=diff&rev=477914&r1=477913&r2=477914 ============================================================================== --- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html (original) +++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html Tue Nov 21 13:52:11 2006 @@ -2,9 +2,9 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 --> +<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 --> <TITLE> -NumberTool (Velocity Tools 1.2 Documentation) +NumberTool (Velocity Tools 1.3-dev Documentation) </TITLE> <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.NumberTool class"> @@ -14,7 +14,7 @@ <SCRIPT type="text/javascript"> function windowTitle() { - parent.document.title="NumberTool (Velocity Tools 1.2 Documentation)"; + parent.document.title="NumberTool (Velocity Tools 1.3-dev Documentation)"; } </SCRIPT> <NOSCRIPT> @@ -212,6 +212,14 @@ <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html#currency(java.lang.Object)">currency</A></B>(java.lang.Object obj)</CODE> + +<BR> + Convenience method equivalent to $number.format("currency", $foo).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html#format(java.lang.Object)">format</A></B>(java.lang.Object obj)</CODE> <BR> @@ -300,6 +308,30 @@ </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html#integer(java.lang.Object)">integer</A></B>(java.lang.Object obj)</CODE> + +<BR> + Convenience method equivalent to $number.format("integer", $foo).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html#number(java.lang.Object)">number</A></B>(java.lang.Object obj)</CODE> + +<BR> + Convenience method equivalent to $number.format("number", $foo).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html#percent(java.lang.Object)">percent</A></B>(java.lang.Object obj)</CODE> + +<BR> + Convenience method equivalent to $number.format("percent", $foo).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Number</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/NumberTool.html#toNumber(java.lang.Object)">toNumber</A></B>(java.lang.Object obj)</CODE> @@ -488,6 +520,66 @@ </DL> <HR> +<A NAME="currency(java.lang.Object)"><!-- --></A><H3> +currency</H3> +<PRE> +public java.lang.String <B>currency</B>(java.lang.Object obj)</PRE> +<DL> +<DD>Convenience method equivalent to $number.format("currency", $foo). +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>VelocityTools 1.3</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="integer(java.lang.Object)"><!-- --></A><H3> +integer</H3> +<PRE> +public java.lang.String <B>integer</B>(java.lang.Object obj)</PRE> +<DL> +<DD>Convenience method equivalent to $number.format("integer", $foo). +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>VelocityTools 1.3</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="number(java.lang.Object)"><!-- --></A><H3> +number</H3> +<PRE> +public java.lang.String <B>number</B>(java.lang.Object obj)</PRE> +<DL> +<DD>Convenience method equivalent to $number.format("number", $foo). +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>VelocityTools 1.3</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="percent(java.lang.Object)"><!-- --></A><H3> +percent</H3> +<PRE> +public java.lang.String <B>percent</B>(java.lang.Object obj)</PRE> +<DL> +<DD>Convenience method equivalent to $number.format("percent", $foo). +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>VelocityTools 1.3</DD> +</DL> +</DD> +</DL> +<HR> + <A NAME="format(java.lang.String, java.lang.Object)"><!-- --></A><H3> format</H3> <PRE> @@ -714,6 +806,6 @@ <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> -Copyright (c) 2003 Apache Software Foundation +Copyright (c) 2003-2006 Apache Software Foundation </BODY> </HTML> Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html?view=diff&rev=477914&r1=477913&r2=477914 ============================================================================== --- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html (original) +++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html Tue Nov 21 13:52:11 2006 @@ -2,9 +2,9 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 --> +<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 --> <TITLE> -RenderTool (Velocity Tools 1.2 Documentation) +RenderTool (Velocity Tools 1.3-dev Documentation) </TITLE> <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.RenderTool class"> @@ -14,7 +14,7 @@ <SCRIPT type="text/javascript"> function windowTitle() { - parent.document.title="RenderTool (Velocity Tools 1.2 Documentation)"; + parent.document.title="RenderTool (Velocity Tools 1.3-dev Documentation)"; } </SCRIPT> <NOSCRIPT> @@ -134,6 +134,12 @@ ------ hello world! + + Toolbox configuration: + <tool> + <key>render</key> + <class>org.apache.velocity.tools.generic.RenderTool</class> + </tool> </pre> <p>Ok, so these examples are really lame. But, it seems like @@ -181,6 +187,14 @@ </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#KEY_PARSE_DEPTH">KEY_PARSE_DEPTH</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#LOG_TAG">LOG_TAG</A></B></CODE> @@ -223,6 +237,14 @@ </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#configure(java.util.Map)">configure</A></B>(java.util.Map params)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#eval(org.apache.velocity.context.Context, java.lang.String)">eval</A></B>(org.apache.velocity.context.Context ctx, java.lang.String vtl)</CODE> @@ -313,6 +335,16 @@ </DL> <HR> +<A NAME="KEY_PARSE_DEPTH"><!-- --></A><H3> +KEY_PARSE_DEPTH</H3> +<PRE> +public static final java.lang.String <B>KEY_PARSE_DEPTH</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.RenderTool.KEY_PARSE_DEPTH">Constant Field Values</A></DL> +</DL> +<HR> + <A NAME="LOG_TAG"><!-- --></A><H3> LOG_TAG</H3> <PRE> @@ -369,6 +401,17 @@ </TR> </TABLE> +<A NAME="configure(java.util.Map)"><!-- --></A><H3> +configure</H3> +<PRE> +public void <B>configure</B>(java.util.Map params)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + <A NAME="setVelocityEngine(org.apache.velocity.app.VelocityEngine)"><!-- --></A><H3> setVelocityEngine</H3> <PRE> @@ -531,6 +574,6 @@ <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> -Copyright (c) 2003 Apache Software Foundation +Copyright (c) 2003-2006 Apache Software Foundation </BODY> </HTML> Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html?view=diff&rev=477914&r1=477913&r2=477914 ============================================================================== --- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html (original) +++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html Tue Nov 21 13:52:11 2006 @@ -2,9 +2,9 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 --> +<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 --> <TITLE> -SortTool.PropertiesComparator (Velocity Tools 1.2 Documentation) +SortTool.PropertiesComparator (Velocity Tools 1.3-dev Documentation) </TITLE> <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.SortTool.PropertiesComparator class"> @@ -14,7 +14,7 @@ <SCRIPT type="text/javascript"> function windowTitle() { - parent.document.title="SortTool.PropertiesComparator (Velocity Tools 1.2 Documentation)"; + parent.document.title="SortTool.PropertiesComparator (Velocity Tools 1.3-dev Documentation)"; } </SCRIPT> <NOSCRIPT> @@ -392,6 +392,6 @@ <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> -Copyright (c) 2003 Apache Software Foundation +Copyright (c) 2003-2006 Apache Software Foundation </BODY> </HTML> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
