You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by nb...@apache.org on 2006/12/22 06:44:18 UTC
svn commit: r489560 [7/15] - in /velocity/tools/trunk/docs: ./ generic/
javadoc/ javadoc/org/apache/velocity/tools/generic/
javadoc/org/apache/velocity/tools/generic/log/
javadoc/org/apache/velocity/tools/struts/
javadoc/org/apache/velocity/tools/view/...
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/ListTool.html Thu Dec 21 21:44:15 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_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:shinobu@ieee.org">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>
+<!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 Dec 21 21:15:30 PST 2006 -->
+<TITLE>
+ListTool (VelocityTools 1.3-beta1 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 (VelocityTools 1.3-beta1 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:shinobu@ieee.org">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: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/MathTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:30 PST 2006 -->
<TITLE>
-MathTool (Velocity Tools 1.3-dev Documentation)
+MathTool (VelocityTools 1.3-beta1 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.3-dev Documentation)";
+ parent.document.title="MathTool (VelocityTools 1.3-beta1 Documentation)";
}
</SCRIPT>
<NOSCRIPT>
@@ -126,7 +126,7 @@
<DT><B>Version:</B></DT>
<DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
- <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a>, Leon Messerschmidt</DD>
+ <DD>Nathan Bubna, Leon Messerschmidt</DD>
</DL>
<HR>
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/NumberTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:30 PST 2006 -->
<TITLE>
-NumberTool (Velocity Tools 1.3-dev Documentation)
+NumberTool (VelocityTools 1.3-beta1 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.3-dev Documentation)";
+ parent.document.title="NumberTool (VelocityTools 1.3-beta1 Documentation)";
}
</SCRIPT>
<NOSCRIPT>
@@ -130,7 +130,7 @@
<DT><B>Version:</B></DT>
<DD>$Id$</DD>
<DT><B>Author:</B></DT>
- <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a>, <a href="mailto:mkienenb@alaska.net">Mike Kienenberger</a></DD>
+ <DD>Nathan Bubna, <a href="mailto:mkienenb@alaska.net">Mike Kienenberger</a></DD>
</DL>
<HR>
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/RenderTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:30 PST 2006 -->
<TITLE>
-RenderTool (Velocity Tools 1.3-dev Documentation)
+RenderTool (VelocityTools 1.3-beta1 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.3-dev Documentation)";
+ parent.document.title="RenderTool (VelocityTools 1.3-beta1 Documentation)";
}
</SCRIPT>
<NOSCRIPT>
@@ -156,7 +156,7 @@
<DT><B>Version:</B></DT>
<DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
- <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+ <DD>Nathan Bubna</DD>
</DL>
<HR>
@@ -171,6 +171,14 @@
</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/RenderTool.html#catchExceptions">catchExceptions</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#DEFAULT_PARSE_DEPTH">DEFAULT_PARSE_DEPTH</A></B></CODE>
@@ -188,6 +196,14 @@
<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_CATCH_EXCEPTIONS">KEY_CATCH_EXCEPTIONS</A></B></CODE>
+
+<BR>
+ </TD>
+</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>
@@ -241,7 +257,7 @@
<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>
+ Looks for parse depth and catch.exceptions parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -255,6 +271,15 @@
</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/RenderTool.html#getCatchExceptions()">getCatchExceptions</A></B>()</CODE>
+
+<BR>
+ Returns <code>true</code> if this render() and eval() methods will
+ catch exceptions thrown during rendering.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#getParseDepth()">getParseDepth</A></B>()</CODE>
@@ -263,6 +288,15 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#internalEval(org.apache.velocity.context.Context, java.lang.String)">internalEval</A></B>(org.apache.velocity.context.Context ctx,
+ java.lang.String vtl)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/RenderTool.html#internalRecurse(org.apache.velocity.context.Context, java.lang.String, int)">internalRecurse</A></B>(org.apache.velocity.context.Context ctx,
java.lang.String vtl,
@@ -284,6 +318,15 @@
<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#setCatchExceptions(boolean)">setCatchExceptions</A></B>(boolean catchExceptions)</CODE>
+
+<BR>
+ Sets whether or not the render() and eval() methods should catch
+ exceptions during their execution or not.</TD>
+</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#setParseDepth(int)">setParseDepth</A></B>(int depth)</CODE>
<BR>
@@ -345,6 +388,16 @@
</DL>
<HR>
+<A NAME="KEY_CATCH_EXCEPTIONS"><!-- --></A><H3>
+KEY_CATCH_EXCEPTIONS</H3>
+<PRE>
+public static final java.lang.String <B>KEY_CATCH_EXCEPTIONS</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.RenderTool.KEY_CATCH_EXCEPTIONS">Constant Field Values</A></DL>
+</DL>
+<HR>
+
<A NAME="LOG_TAG"><!-- --></A><H3>
LOG_TAG</H3>
<PRE>
@@ -373,6 +426,16 @@
<DL>
</DL>
</DL>
+<HR>
+
+<A NAME="catchExceptions"><!-- --></A><H3>
+catchExceptions</H3>
+<PRE>
+private boolean <B>catchExceptions</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
@@ -406,7 +469,11 @@
<PRE>
public void <B>configure</B>(java.util.Map params)</PRE>
<DL>
+<DD>Looks for parse depth and catch.exceptions parameters.
+<P>
<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.3</DD>
</DL>
</DD>
</DL>
@@ -456,6 +523,38 @@
</DL>
<HR>
+<A NAME="setCatchExceptions(boolean)"><!-- --></A><H3>
+setCatchExceptions</H3>
+<PRE>
+public void <B>setCatchExceptions</B>(boolean catchExceptions)</PRE>
+<DL>
+<DD>Sets whether or not the render() and eval() methods should catch
+ exceptions during their execution or not.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCatchExceptions()"><!-- --></A><H3>
+getCatchExceptions</H3>
+<PRE>
+public boolean <B>getCatchExceptions</B>()</PRE>
+<DL>
+<DD>Returns <code>true</code> if this render() and eval() methods will
+ catch exceptions thrown during rendering.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="eval(org.apache.velocity.context.Context, java.lang.String)"><!-- --></A><H3>
eval</H3>
<PRE>
@@ -464,13 +563,28 @@
throws java.lang.Exception</PRE>
<DL>
<DD><p>Evaluates a String containing VTL using the current context,
- and returns the result as a String. If this fails, then
- <code>null</code> will be returned. This evaluation is not
- recursive.</p>
+ and returns the result as a String. By default if this fails, then
+ <code>null</code> will be returned, though this tool can be configured
+ to let Exceptions pass through. This evaluation is not recursive.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ctx</CODE> - the current Context<DD><CODE>vtl</CODE> - the code to be evaluated
<DT><B>Returns:</B><DD>the evaluated code as a String
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.Exception</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="internalEval(org.apache.velocity.context.Context, java.lang.String)"><!-- --></A><H3>
+internalEval</H3>
+<PRE>
+private java.lang.String <B>internalEval</B>(org.apache.velocity.context.Context ctx,
+ java.lang.String vtl)
+ throws java.lang.Exception</PRE>
+<DL>
+<DD><DL>
+
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/SortTool.PropertiesComparator.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:25 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:30 PST 2006 -->
<TITLE>
-SortTool.PropertiesComparator (Velocity Tools 1.3-dev Documentation)
+SortTool.PropertiesComparator (VelocityTools 1.3-beta1 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.3-dev Documentation)";
+ parent.document.title="SortTool.PropertiesComparator (VelocityTools 1.3-beta1 Documentation)";
}
</SCRIPT>
<NOSCRIPT>