You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by nb...@apache.org on 2005/10/20 20:36:27 UTC
svn commit: r326968 [3/21] - in /jakarta/velocity/tools/trunk/docs/javadoc:
./ org/apache/velocity/tools/generic/
org/apache/velocity/tools/generic/log/ org/apache/velocity/tools/struts/
org/apache/velocity/tools/view/ org/apache/velocity/tools/view/co...
Modified: jakarta/velocity/tools/trunk/docs/javadoc/index.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/index.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/index.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/index.html Thu Oct 20 11:34:40 2005
@@ -1,19 +1,29 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sat Feb 21 10:25:30 PST 2004-->
+<!-- Generated by javadoc on Thu Oct 20 10:35:35 PDT 2005-->
<TITLE>
-Velocity Tools 1.1-rc1 Documentation
+Velocity Tools 1.2 Documentation
</TITLE>
+<SCRIPT type="text/javascript">
+ targetPage = "" + window.location.search;
+ if (targetPage != "" && targetPage != "undefined")
+ targetPage = targetPage.substring(1);
+ function loadFrames() {
+ if (targetPage != "" && targetPage != "undefined")
+ top.classFrame.location = top.targetPage;
+ }
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
-<FRAMESET cols="20%,80%">
-<FRAMESET rows="30%,70%">
-<FRAME src="overview-frame.html" name="packageListFrame">
-<FRAME src="allclasses-frame.html" name="packageFrame">
-</FRAMESET>
-<FRAME src="overview-summary.html" name="classFrame">
+<FRAMESET cols="20%,80%" title="" onLoad="top.loadFrames()">
+<FRAMESET rows="30%,70%" title="" onLoad="top.loadFrames()">
+<FRAME src="overview-frame.html" name="packageListFrame" title="All Packages">
+<FRAME src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)">
</FRAMESET>
+<FRAME src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes">
<NOFRAMES>
<H2>
Frame Alert</H2>
@@ -21,5 +31,7 @@
<P>
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
<BR>
-Link to<A HREF="overview-summary.html">Non-frame version.</A></NOFRAMES>
+Link to<A HREF="overview-summary.html">Non-frame version.</A>
+</NOFRAMES>
+</FRAMESET>
</HTML>
Added: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/Alternator.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/Alternator.html?rev=326968&view=auto
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/Alternator.html (added)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/Alternator.html Thu Oct 20 11:34:40 2005
@@ -0,0 +1,533 @@
+<!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:33 PDT 2005 -->
+<TITLE>
+Alternator (Velocity Tools 1.2 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.Alternator class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Alternator (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">
+ PREV CLASS
+ <A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.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/Alternator.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Alternator.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <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 Alternator</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.Alternator</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>Alternator</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+Utility class for easily alternating over values in a list.
+
+ <p><b>Example usage:</b>
+ <pre>
+ java...
+ String[] myColors = new String[]{"red", "blue"};
+ context.put("color", new Alternator(myColors));
+ String[] myStyles = new String[]{"hip", "fly", "groovy"};
+ // demonstrate manual alternation with this one
+ context.put("style", new Alternator(false, myStyles));
+
+ template...
+ #foreach( $foo in [1..5] )
+ $foo is $color and $style.next
+ #end
+
+ output...
+ 1 is red and hip
+ 2 is blue and fly
+ 3 is red and groovy
+ 4 is blue and hip
+ 5 is red and fly
+ </pre></p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>Velocity Tools 1.2</DD>
+<DT><B>Version:</B></DT>
+ <DD>$Revision: 72057 $ $Date: 2004-05-05 17:36:40 -0700 (Wed, 05 May 2004) $</DD>
+</DL>
+<HR>
+
+<P>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_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>Field Summary</B></FONT></TH>
+</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/Alternator.html#auto">auto</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#index">index</A></B></CODE>
+
+<BR>
+ </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/Alternator.html#list">list</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ======== 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/Alternator.html#Alternator(boolean, java.util.List)">Alternator</A></B>(boolean auto,
+ java.util.List list)</CODE>
+
+<BR>
+ Creates a new Alternator for the specified list with the specified
+ automatic shifting preference.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#Alternator(boolean, java.lang.Object[])">Alternator</A></B>(boolean auto,
+ java.lang.Object[] list)</CODE>
+
+<BR>
+ Creates a new Alternator for the specified list with the specified
+ automatic shifting preference.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#Alternator(java.util.List)">Alternator</A></B>(java.util.List list)</CODE>
+
+<BR>
+ Creates a new Alternator for the specified list.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#Alternator(java.lang.Object[])">Alternator</A></B>(java.lang.Object[] list)</CODE>
+
+<BR>
+ Creates a new Alternator for the specified list.</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> java.lang.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#getCurrent()">getCurrent</A></B>()</CODE>
+
+<BR>
+ Returns the current item without shifting the list index.</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/Alternator.html#getNext()">getNext</A></B>()</CODE>
+
+<BR>
+ Returns the current item, then shifts the list index.</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/Alternator.html#isAuto()">isAuto</A></B>()</CODE>
+
+<BR>
+ </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/Alternator.html#setAuto(boolean)">setAuto</A></B>(boolean auto)</CODE>
+
+<BR>
+ If set to true, the list index will shift automatically after a
+ call to toString().</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/Alternator.html#shift()">shift</A></B>()</CODE>
+
+<BR>
+ Manually shifts the list index.</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/Alternator.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ Returns a string representation of the current item or
+ <code>null</code> if the current item is null.</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, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_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>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="list"><!-- --></A><H3>
+list</H3>
+<PRE>
+private java.lang.Object[] <B>list</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="index"><!-- --></A><H3>
+index</H3>
+<PRE>
+private int <B>index</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="auto"><!-- --></A><H3>
+auto</H3>
+<PRE>
+private boolean <B>auto</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+
+<!-- ========= 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="Alternator(java.util.List)"><!-- --></A><H3>
+Alternator</H3>
+<PRE>
+public <B>Alternator</B>(java.util.List list)</PRE>
+<DL>
+<DD>Creates a new Alternator for the specified list. Alternation
+ defaults to automatic.
+<P>
+</DL>
+<HR>
+
+<A NAME="Alternator(java.lang.Object[])"><!-- --></A><H3>
+Alternator</H3>
+<PRE>
+public <B>Alternator</B>(java.lang.Object[] list)</PRE>
+<DL>
+<DD>Creates a new Alternator for the specified list. Alternation
+ defaults to automatic.
+<P>
+</DL>
+<HR>
+
+<A NAME="Alternator(boolean, java.util.List)"><!-- --></A><H3>
+Alternator</H3>
+<PRE>
+public <B>Alternator</B>(boolean auto,
+ java.util.List list)</PRE>
+<DL>
+<DD>Creates a new Alternator for the specified list with the specified
+ automatic shifting preference.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>auto</CODE> - See <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#setAuto(boolean)"><CODE>setAuto(boolean auto)</CODE></A>.<DD><CODE>list</CODE> - The (non-<code>null</code>) list of elements to
+ alternate.</DL>
+</DL>
+<HR>
+
+<A NAME="Alternator(boolean, java.lang.Object[])"><!-- --></A><H3>
+Alternator</H3>
+<PRE>
+public <B>Alternator</B>(boolean auto,
+ java.lang.Object[] list)</PRE>
+<DL>
+<DD>Creates a new Alternator for the specified list with the specified
+ automatic shifting preference.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>auto</CODE> - See <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#setAuto(boolean)"><CODE>setAuto(boolean auto)</CODE></A>.<DD><CODE>list</CODE> - The (non-<code>null</code>) list of elements to
+ alternate.</DL>
+</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="isAuto()"><!-- --></A><H3>
+isAuto</H3>
+<PRE>
+public boolean <B>isAuto</B>()</PRE>
+<DL>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Whether this Alternator shifts the list index
+ automatically after a call to <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#toString()"><CODE>toString()</CODE></A>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setAuto(boolean)"><!-- --></A><H3>
+setAuto</H3>
+<PRE>
+public void <B>setAuto</B>(boolean auto)</PRE>
+<DL>
+<DD>If set to true, the list index will shift automatically after a
+ call to toString().
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="shift()"><!-- --></A><H3>
+shift</H3>
+<PRE>
+public void <B>shift</B>()</PRE>
+<DL>
+<DD>Manually shifts the list index. If it reaches the end of the list,
+ it will start over again at zero.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCurrent()"><!-- --></A><H3>
+getCurrent</H3>
+<PRE>
+public java.lang.Object <B>getCurrent</B>()</PRE>
+<DL>
+<DD>Returns the current item without shifting the list index.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNext()"><!-- --></A><H3>
+getNext</H3>
+<PRE>
+public java.lang.Object <B>getNext</B>()</PRE>
+<DL>
+<DD>Returns the current item, then shifts the list index.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public java.lang.String <B>toString</B>()</PRE>
+<DL>
+<DD>Returns a string representation of the current item or
+ <code>null</code> if the current item is null. <b>If <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#auto"><CODE>auto</CODE></A> is true, this will shift after returning the current
+ item</b>.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+</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">
+ PREV CLASS
+ <A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.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/Alternator.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Alternator.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <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>
Added: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/AlternatorTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/AlternatorTool.html?rev=326968&view=auto
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/AlternatorTool.html (added)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/AlternatorTool.html Thu Oct 20 11:34:40 2005
@@ -0,0 +1,414 @@
+<!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:33 PDT 2005 -->
+<TITLE>
+AlternatorTool (Velocity Tools 1.2 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.AlternatorTool class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="AlternatorTool (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/Alternator.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.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/AlternatorTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="AlternatorTool.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 AlternatorTool</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.AlternatorTool</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>AlternatorTool</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+Simple tool to provide easy in-template instantiation of
+ <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A>s from varying "list" types.
+
+ <p><b>Example Use:</b>
+ <pre>
+ toolbox.xml...
+ <tool>
+ <key>alternator</key>
+ <scope>application</scope>
+ <class>org.apache.velocity.tools.generic.AlternatorTool</class>
+ </tool>
+
+ template...
+ #set( $color = $alternator.make('red', 'blue') )
+ ## use manual alternation for this one
+ #set( $style = $alternator.make(false, ['hip','fly','groovy']) )
+ #foreach( $i in [1..5] )
+ $i is $color and $style.next
+ #end
+
+ output...
+ 1 is red and hip
+ 2 is blue and fly
+ 3 is red and groovy
+ 4 is blue and hip
+ 5 is red and fly
+ </pre></p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>Velocity Tools 1.2</DD>
+<DT><B>Version:</B></DT>
+ <DD>$Revision: 72056 $ $Date: 2004-05-05 17:01:27 -0700 (Wed, 05 May 2004) $</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/AlternatorTool.html#AlternatorTool()">AlternatorTool</A></B>()</CODE>
+
+<BR>
+ </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> <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#make(boolean, java.util.List)">make</A></B>(boolean auto,
+ java.util.List list)</CODE>
+
+<BR>
+ Make an <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a List.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#make(boolean, java.lang.Object[])">make</A></B>(boolean auto,
+ java.lang.Object[] array)</CODE>
+
+<BR>
+ Make an <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from an object array.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#make(boolean, java.lang.Object, java.lang.Object)">make</A></B>(boolean auto,
+ java.lang.Object o1,
+ java.lang.Object o2)</CODE>
+
+<BR>
+ Make an <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a list containing the two
+ specified objects.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#make(java.util.List)">make</A></B>(java.util.List list)</CODE>
+
+<BR>
+ Make an automatic <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a List.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#make(java.lang.Object[])">make</A></B>(java.lang.Object[] array)</CODE>
+
+<BR>
+ Make an automatic <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from an object array.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#make(java.lang.Object, java.lang.Object)">make</A></B>(java.lang.Object o1,
+ java.lang.Object o2)</CODE>
+
+<BR>
+ Make an automatic <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a list containing the two
+ specified objects.</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="AlternatorTool()"><!-- --></A><H3>
+AlternatorTool</H3>
+<PRE>
+public <B>AlternatorTool</B>()</PRE>
+<DL>
+</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="make(java.util.List)"><!-- --></A><H3>
+make</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>make</B>(java.util.List list)</PRE>
+<DL>
+<DD>Make an automatic <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a List.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="make(boolean, java.util.List)"><!-- --></A><H3>
+make</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>make</B>(boolean auto,
+ java.util.List list)</PRE>
+<DL>
+<DD>Make an <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a List.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The new Alternator, or <code>null</code> if arguments
+ were illegal.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="make(java.lang.Object[])"><!-- --></A><H3>
+make</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>make</B>(java.lang.Object[] array)</PRE>
+<DL>
+<DD>Make an automatic <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from an object array.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="make(boolean, java.lang.Object[])"><!-- --></A><H3>
+make</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>make</B>(boolean auto,
+ java.lang.Object[] array)</PRE>
+<DL>
+<DD>Make an <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from an object array.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The new Alternator, or <code>null</code> if arguments
+ were illegal.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="make(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
+make</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>make</B>(java.lang.Object o1,
+ java.lang.Object o2)</PRE>
+<DL>
+<DD>Make an automatic <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a list containing the two
+ specified objects.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The new Alternator, or <code>null</code> if arguments
+ were illegal.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="make(boolean, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
+make</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>make</B>(boolean auto,
+ java.lang.Object o1,
+ java.lang.Object o2)</PRE>
+<DL>
+<DD>Make an <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from a list containing the two
+ specified objects.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>o1</CODE> - The first of two objects for alternation between.
+ Must be non-<code>null</code>.<DD><CODE>o2</CODE> - The second of two objects for alternation between.
+ Must be non-<code>null</code>.
+<DT><B>Returns:</B><DD>The new Alternator, or <code>null</code> if arguments
+ were illegal.</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/Alternator.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.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/AlternatorTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="AlternatorTool.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>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/DateTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/DateTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/DateTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/generic/DateTool.html Thu Oct 20 11:34:40 2005
@@ -1,29 +1,38 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sat Feb 21 10:25:32 PST 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:33 PDT 2005 -->
<TITLE>
-DateTool (Velocity Tools 1.1-rc1 Documentation)
+DateTool (Velocity Tools 1.2 Documentation)
</TITLE>
-<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.DateTool,DateTool class">
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.DateTool class">
+
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
-</HEAD>
-<SCRIPT>
-function asd()
+
+<SCRIPT type="text/javascript">
+function windowTitle()
{
-parent.document.title="DateTool (Velocity Tools 1.1-rc1 Documentation)";
+ parent.document.title="DateTool (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
-<BODY BGCOLOR="white" onload="asd();">
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
-<!-- ========== START OF NAVBAR ========== -->
+<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+<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>
@@ -42,22 +51,23 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- <A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.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" TARGET="_top"><B>FRAMES</B></A>
- <A HREF="DateTool.html" TARGET="_top"><B>NO FRAMES</B></A>
-
-<SCRIPT>
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/DateTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="DateTool.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
<!--
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
+ document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
-<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
+ <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
+
</FONT></TD>
</TR>
<TR>
@@ -67,7 +77,8 @@
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
-<!-- =========== END OF NAVBAR =========== -->
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
@@ -78,12 +89,12 @@
Class DateTool</H2>
<PRE>
java.lang.Object
- |
- +--<B>org.apache.velocity.tools.generic.DateTool</B>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.DateTool</B>
</PRE>
<HR>
<DL>
-<DT>public class <B>DateTool</B><DT>extends java.lang.Object</DL>
+<DT><PRE>public class <B>DateTool</B><DT>extends java.lang.Object</DL>
+</PRE>
<P>
Tool for working with <CODE>Date</CODE> and <CODE>Calendar</CODE>
@@ -100,9 +111,9 @@
$date.full_date -> Sunday, October 19, 2003
$date.get('default','short') -> Oct 19, 2003 9:54 PM
$date.get('yyyy-M-d H:m:s') -> 2003-10-19 21:54:50
-
+
$myDate -> Tue Oct 07 03:14:50 PDT 2003
- $date.format('medium',$myDate) -> Oct 7, 2003 3:14:50 AM
+ $date.format('medium',$myDate) -> Oct 7, 2003 3:14:50 AM
Example toolbox.xml config (if you want to use this with VelocityView):
<tool>
@@ -114,8 +125,8 @@
<p>This tool is entirely threadsafe, and has no instance members.
It may be used in any scope (request, session, or application).
- As such, the methods are highly interconnected, and overriding
- key methods provides an easy way to create subclasses that use
+ As such, the methods are highly interconnected, and overriding
+ key methods provides an easy way to create subclasses that use
a non-default format, calendar, locale, or timezone.</p>
<P>
@@ -124,23 +135,20 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.0</DD>
<DT><B>Version:</B></DT>
- <DD>$Revision: 1.7 $ $Date: 2004/02/21 18:33:02 $</DD>
+ <DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
<HR>
<P>
-<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -155,10 +163,10 @@
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Constructor Summary</B></FONT></TD>
+<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/DateTool.html#DateTool()">DateTool</A></B>()</CODE>
@@ -171,10 +179,10 @@
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TD>
+<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">
@@ -329,21 +337,29 @@
</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/DateTool.html#getFormat()">getFormat</A></B>()</CODE>
+<CODE> java.lang.Integer</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getDay()">getDay</A></B>()</CODE>
<BR>
- Return the pattern or style to be used for formatting dates when none
- is specified.</TD>
+ Returns the day (of the month) value of the date
+ returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A>.</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/DateTool.html#getDay(java.lang.Object)">getDay</A></B>(java.lang.Object date)</CODE>
+
+<BR>
+ Returns the day (of the month) value for the specified date.</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/DateTool.html#getFormattedDate(java.lang.String)">getFormattedDate</A></B>(java.lang.String format)</CODE>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getFormat()">getFormat</A></B>()</CODE>
<BR>
- <B>Deprecated.</B> <I>use <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#get(java.lang.String)"><CODE>get(String format)</CODE></A> instead. This will be
- removed in VelocityTools 1.2</I></TD>
+ Return the pattern or style to be used for formatting dates when none
+ is specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -355,6 +371,22 @@
</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/DateTool.html#getMonth()">getMonth</A></B>()</CODE>
+
+<BR>
+ Returns the month value of the date returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A>.</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/DateTool.html#getMonth(java.lang.Object)">getMonth</A></B>(java.lang.Object date)</CODE>
+
+<BR>
+ Returns the month value of the specified date.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getStyleAsInt(java.lang.String)">getStyleAsInt</A></B>(java.lang.String style)</CODE>
@@ -388,6 +420,51 @@
</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/DateTool.html#getValue(int, java.lang.Object)">getValue</A></B>(int field,
+ java.lang.Object date)</CODE>
+
+<BR>
+ Returns the specified value of the specified date,
+ or null if the field or date is invalid.</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/DateTool.html#getValue(java.lang.Object)">getValue</A></B>(java.lang.Object field)</CODE>
+
+<BR>
+ Return the specified value of the date returned by
+ <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A> or null if the field is invalid.</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/DateTool.html#getValue(java.lang.Object, java.lang.Object)">getValue</A></B>(java.lang.Object field,
+ java.lang.Object date)</CODE>
+
+<BR>
+ Returns the specified value of the specified date,
+ or null if the field or date is invalid.</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/DateTool.html#getYear()">getYear</A></B>()</CODE>
+
+<BR>
+ Returns the year value of the date returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A>.</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/DateTool.html#getYear(java.lang.Object)">getYear</A></B>(java.lang.Object date)</CODE>
+
+<BR>
+ Returns the year value of the specified date.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Calendar</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#toCalendar(java.lang.Object)">toCalendar</A></B>(java.lang.Object obj)</CODE>
@@ -412,7 +489,7 @@
<BR>
Converts an object to an instance of <CODE>Date</CODE> using the
- format returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getFormat()"><CODE>getFormat()</CODE></A>,the <CODE>Locale</CODE> returned
+ format returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getFormat()"><CODE>getFormat()</CODE></A>,the <CODE>Locale</CODE> returned
by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getLocale()"><CODE>getLocale()</CODE></A>, and the <CODE>TimeZone</CODE> returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getTimeZone()"><CODE>getTimeZone()</CODE></A> if the object is not already an instance
of Date, Calendar, or Long.</TD>
@@ -425,7 +502,7 @@
<BR>
Converts an object to an instance of <CODE>Date</CODE> using the
- specified format,the <CODE>Locale</CODE> returned by
+ specified format,the <CODE>Locale</CODE> returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getLocale()"><CODE>getLocale()</CODE></A>, and the <CODE>TimeZone</CODE> returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getTimeZone()"><CODE>getTimeZone()</CODE></A> if the object is not already an instance
of Date, Calendar, or Long.</TD>
@@ -452,7 +529,7 @@
<BR>
Converts an object to an instance of <CODE>Date</CODE> using the
- specified format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE> if the
+ specified format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE> if the
object is not already an instance of Date, Calendar, or Long.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -465,9 +542,9 @@
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Methods inherited from class java.lang.Object</B></TD>
+<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, wait, wait, wait</CODE></TD>
@@ -479,10 +556,10 @@
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -502,10 +579,10 @@
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Constructor Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -521,10 +598,10 @@
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -611,14 +688,14 @@
<p>Sub-classes may override this method to return a Calendar instance
not based on the system date.
- Doing so will also cause the getDate(), get(String), get(String,String),
- and toString() methods to return dates equivalent to the Calendar
- returned by this method, because those methods return values derived
+ Doing so will also cause the getDate(), get(String), get(String,String),
+ and toString() methods to return dates equivalent to the Calendar
+ returned by this method, because those methods return values derived
from the result of this method.</p>
<P>
<DD><DL>
-<DT><B>Returns:</B><DD>a <CODE>Calendar</CODE> instance created using the results of
+<DT><B>Returns:</B><DD>a <CODE>Calendar</CODE> instance created using the results of
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getTimeZone()"><CODE>getTimeZone()</CODE></A> and <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getLocale()"><CODE>getLocale()</CODE></A>.<DT><B>See Also:</B><DD><CODE>Calendar.getInstance(TimeZone zone, Locale aLocale)</CODE></DL>
</DD>
</DL>
@@ -630,12 +707,12 @@
public java.lang.String <B>getFormat</B>()</PRE>
<DL>
<DD>Return the pattern or style to be used for formatting dates when none
- is specified. This implementation gives a 'default' date-time format.
+ is specified. This implementation gives a 'default' date-time format.
Subclasses may override this to provide a different default format.
<p>NOTE: At some point in the future it may be feasible to configure
this value via the toolbox definition, but at present, it is not possible
- to specify custom tool configurations there. For now you should just
+ to specify custom tool configurations there. For now you should just
override this in a subclass to have a different default.</p>
<P>
<DD><DL>
@@ -646,15 +723,155 @@
</DL>
<HR>
-<A NAME="getFormattedDate(java.lang.String)"><!-- --></A><H3>
-getFormattedDate</H3>
+<A NAME="getYear()"><!-- --></A><H3>
+getYear</H3>
<PRE>
-public java.lang.String <B>getFormattedDate</B>(java.lang.String format)</PRE>
+public java.lang.Integer <B>getYear</B>()</PRE>
<DL>
-<DD><B>Deprecated.</B> <I>use <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#get(java.lang.String)"><CODE>get(String format)</CODE></A> instead. This will be
- removed in VelocityTools 1.2</I>
+<DD>Returns the year value of the date returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A>.
<P>
<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getYear(java.lang.Object)"><!-- --></A><H3>
+getYear</H3>
+<PRE>
+public java.lang.Integer <B>getYear</B>(java.lang.Object date)</PRE>
+<DL>
+<DD>Returns the year value of the specified date.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMonth()"><!-- --></A><H3>
+getMonth</H3>
+<PRE>
+public java.lang.Integer <B>getMonth</B>()</PRE>
+<DL>
+<DD>Returns the month value of the date returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A>.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMonth(java.lang.Object)"><!-- --></A><H3>
+getMonth</H3>
+<PRE>
+public java.lang.Integer <B>getMonth</B>(java.lang.Object date)</PRE>
+<DL>
+<DD>Returns the month value of the specified date.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getDay()"><!-- --></A><H3>
+getDay</H3>
+<PRE>
+public java.lang.Integer <B>getDay</B>()</PRE>
+<DL>
+<DD>Returns the day (of the month) value of the date
+ returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A>.
+ <br><br>
+ NOTE: Unlike java.util.Date, this returns the day of the month.
+ It is equivalent to Date.getDate() and
+ Calendar.get(Calendar.DAY_OF_MONTH). We could not call this method
+ getDate() because that already exists in this class with a different
+ function.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getDay(java.lang.Object)"><!-- --></A><H3>
+getDay</H3>
+<PRE>
+public java.lang.Integer <B>getDay</B>(java.lang.Object date)</PRE>
+<DL>
+<DD>Returns the day (of the month) value for the specified date.
+ <br><br>
+ NOTE: Unlike java.util.Date, this returns the day of the month.
+ It is equivalent to Date.getDate() and
+ Calendar.get(Calendar.DAY_OF_MONTH). We could not call this method
+ getDate() because that already exists in this class with a different
+ function.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getValue(java.lang.Object)"><!-- --></A><H3>
+getValue</H3>
+<PRE>
+public java.lang.Integer <B>getValue</B>(java.lang.Object field)</PRE>
+<DL>
+<DD>Return the specified value of the date returned by
+ <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getCalendar()"><CODE>getCalendar()</CODE></A> or null if the field is invalid.
+<P>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getValue(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
+getValue</H3>
+<PRE>
+public java.lang.Integer <B>getValue</B>(java.lang.Object field,
+ java.lang.Object date)</PRE>
+<DL>
+<DD>Returns the specified value of the specified date,
+ or null if the field or date is invalid. The field may be
+ an Integer or it may be the name of the field as a String.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>field</CODE> - the corresponding Integer value or String name of the desired value<DD><CODE>date</CODE> - the date/calendar from which the field value will be taken<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getValue(int, java.lang.Object)"><!-- --></A><H3>
+getValue</H3>
+<PRE>
+public java.lang.Integer <B>getValue</B>(int field,
+ java.lang.Object date)</PRE>
+<DL>
+<DD>Returns the specified value of the specified date,
+ or null if the field or date is invalid.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>field</CODE> - the int for the desired field (e.g. Calendar.MONTH)<DD><CODE>date</CODE> - the date/calendar from which the field value will be taken<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</DD>
</DL>
</DD>
</DL>
@@ -666,11 +883,11 @@
public java.lang.String <B>get</B>(java.lang.String format)</PRE>
<DL>
<DD>Returns a formatted string representing the date returned by
- <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getDate()"><CODE>getDate()</CODE></A>. In its default implementation, this method
+ <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getDate()"><CODE>getDate()</CODE></A>. In its default implementation, this method
allows you to retrieve the current date in standard formats by
- simply doing things like <code>$date.medium</code> or
+ simply doing things like <code>$date.medium</code> or
<code>$date.full</code>. If you want only the date or time portion
- you can specify that along with the standard formats. (e.g.
+ you can specify that along with the standard formats. (e.g.
<code>$date.medium_date</code> or <code>$date.short_time</code>)
More complex or custom formats can be retrieved
by using the full method syntax. (e.g. $date.get('E, MMMM d'))
@@ -699,7 +916,7 @@
<DT><B>Returns:</B><DD>a formatted representation of the date returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getDate()"><CODE>getDate()</CODE></A><DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
-<DT><B>See Also:</B><DD><CODE>DateFormat</CODE>,
+<DT><B>See Also:</B><DD><CODE>DateFormat</CODE>,
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#format(java.lang.String, java.lang.String, java.lang.Object, java.util.Locale, java.util.TimeZone)"><CODE>format(String dateStyle, String timeStyle, Object obj, Locale locale, TimeZone timezone)</CODE></A></DL>
</DD>
</DL>
@@ -779,8 +996,8 @@
(e.g. 'full_date' or 'long_time')
</p>
<p>
- If the format fits neither of these patterns, then the output
- will be formatted according to the symbols defined by
+ If the format fits neither of these patterns, then the output
+ will be formatted according to the symbols defined by
<CODE>SimpleDateFormat</CODE>:
<pre>
Symbol Meaning Presentation Example
@@ -876,7 +1093,7 @@
<DT><B>Parameters:</B><DD><CODE>dateStyle</CODE> - the style pattern for the date<DD><CODE>timeStyle</CODE> - the style pattern for the time<DD><CODE>obj</CODE> - the date to be formatted<DD><CODE>locale</CODE> - the <CODE>Locale</CODE> to be used for formatting the date<DD><CODE>timezone</CODE> - the <CODE>TimeZone</CODE> the date should be formatted for
<DT><B>Returns:</B><DD>a formatted representation of the given date<DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
-<DT><B>See Also:</B><DD><CODE>DateFormat</CODE>,
+<DT><B>See Also:</B><DD><CODE>DateFormat</CODE>,
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#format(java.lang.String, java.lang.String, java.lang.Object, java.util.Locale, java.util.TimeZone)"><CODE>format(String dateStyle, String timeStyle, Object obj, Locale locale, TimeZone timezone)</CODE></A></DL>
</DD>
</DL>
@@ -892,7 +1109,7 @@
<DD>Returns a <CODE>DateFormat</CODE> instance for the specified
format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE>. If the format
specified is a standard style pattern, then a date-time instance
- will be returned with both the date and time styles set to the
+ will be returned with both the date and time styles set to the
specified style. If it is a custom format, then a customized
<CODE>SimpleDateFormat</CODE> will be returned.
<P>
@@ -900,7 +1117,7 @@
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the custom or standard formatting pattern to be used<DD><CODE>locale</CODE> - the <CODE>Locale</CODE> to be used<DD><CODE>timezone</CODE> - the <CODE>TimeZone</CODE> to be used
<DT><B>Returns:</B><DD>an instance of <CODE>DateFormat</CODE><DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
-<DT><B>See Also:</B><DD><CODE>SimpleDateFormat</CODE>,
+<DT><B>See Also:</B><DD><CODE>SimpleDateFormat</CODE>,
<CODE>DateFormat</CODE></DL>
</DD>
</DL>
@@ -956,8 +1173,9 @@
protected int <B>getStyleAsInt</B>(java.lang.String style)</PRE>
<DL>
<DD>Checks a string to see if it matches one of the standard DateFormat
- style patterns: FULL, LONG, MEDIUM, SHORT, or DEFAULT. if it does it will return
- the integer constant for that pattern. if not, it will return -1.
+ style patterns: FULL, LONG, MEDIUM, SHORT, or DEFAULT. If it does,
+ it will return the integer constant for that pattern. If not, it
+ will return -1.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>style</CODE> - the string to be checked
@@ -974,7 +1192,7 @@
public java.util.Date <B>toDate</B>(java.lang.Object obj)</PRE>
<DL>
<DD>Converts an object to an instance of <CODE>Date</CODE> using the
- format returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getFormat()"><CODE>getFormat()</CODE></A>,the <CODE>Locale</CODE> returned
+ format returned by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getFormat()"><CODE>getFormat()</CODE></A>,the <CODE>Locale</CODE> returned
by <A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getLocale()"><CODE>getLocale()</CODE></A>, and the <CODE>TimeZone</CODE> returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getTimeZone()"><CODE>getTimeZone()</CODE></A> if the object is not already an instance
of Date, Calendar, or Long.
@@ -994,7 +1212,7 @@
java.lang.Object obj)</PRE>
<DL>
<DD>Converts an object to an instance of <CODE>Date</CODE> using the
- specified format,the <CODE>Locale</CODE> returned by
+ specified format,the <CODE>Locale</CODE> returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getLocale()"><CODE>getLocale()</CODE></A>, and the <CODE>TimeZone</CODE> returned by
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getTimeZone()"><CODE>getTimeZone()</CODE></A> if the object is not already an instance
of Date, Calendar, or Long.
@@ -1035,13 +1253,13 @@
java.util.TimeZone timezone)</PRE>
<DL>
<DD>Converts an object to an instance of <CODE>Date</CODE> using the
- specified format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE> if the
+ specified format, <CODE>Locale</CODE>, and <CODE>TimeZone</CODE> if the
object is not already an instance of Date, Calendar, or Long.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - - the format the date is in<DD><CODE>obj</CODE> - - the date to convert<DD><CODE>locale</CODE> - - the <CODE>Locale</CODE><DD><CODE>timezone</CODE> - - the <CODE>TimeZone</CODE>
<DT><B>Returns:</B><DD>the object as a <CODE>Date</CODE> or <code>null</code> if no
- conversion is possible<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getDateFormat(java.lang.String, java.util.Locale, java.util.TimeZone)"><CODE>getDateFormat(java.lang.String, java.util.Locale, java.util.TimeZone)</CODE></A>,
+ conversion is possible<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#getDateFormat(java.lang.String, java.util.Locale, java.util.TimeZone)"><CODE>getDateFormat(java.lang.String, java.util.Locale, java.util.TimeZone)</CODE></A>,
<CODE>SimpleDateFormat.parse(java.lang.String, java.text.ParsePosition)</CODE></DL>
</DD>
</DL>
@@ -1073,7 +1291,7 @@
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the date to convert<DD><CODE>locale</CODE> - the locale used
-<DT><B>Returns:</B><DD>the converted date<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#toDate(java.lang.String, java.lang.Object, java.util.Locale)"><CODE>toDate(String format, Object obj, Locale locale)</CODE></A>,
+<DT><B>Returns:</B><DD>the converted date<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html#toDate(java.lang.String, java.lang.Object, java.util.Locale)"><CODE>toDate(String format, Object obj, Locale locale)</CODE></A>,
<CODE>Calendar</CODE></DL>
</DD>
</DL>
@@ -1096,13 +1314,15 @@
<!-- ========= END OF CLASS DATA ========= -->
<HR>
-<!-- ========== START OF NAVBAR ========== -->
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+<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>
@@ -1121,22 +1341,23 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- <A HREF="../../../../../org/apache/velocity/tools/generic/IteratorTool.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/generic/EscapeTool.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" TARGET="_top"><B>FRAMES</B></A>
- <A HREF="DateTool.html" TARGET="_top"><B>NO FRAMES</B></A>
-
-<SCRIPT>
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/generic/DateTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="DateTool.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
<!--
if(window==top) {
- document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
+ document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
-<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
+ <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
+
</FONT></TD>
</TR>
<TR>
@@ -1146,7 +1367,8 @@
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
-<!-- =========== END OF NAVBAR =========== -->
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2003 Apache Software Foundation
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org