<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.5.0_14) on Mon Apr 26 10:16:12 PDT 2010 --> | |
<TITLE> | |
AlternatorTool (VelocityTools 2.0 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 (VelocityTools 2.0 Documentation)"; | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#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/ClassTool.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 | <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 AlternatorTool</H2> | |
<PRE> | |
java.lang.Object | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.AlternatorTool</B> | |
</PRE> | |
<HR> | |
<DL> | |
<DT><PRE><FONT SIZE="-1"><A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html" title="annotation in org.apache.velocity.tools.config">@DefaultKey</A>(<A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html#value()">value</A>="alternator") | |
</FONT>public class <B>AlternatorTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></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 or individual | |
arguments. | |
<p><b>Example Use:</b> | |
<pre> | |
tools.xml... | |
<tools> | |
<toolbox scope="application"> | |
<tool class="org.apache.velocity.tools.generic.AlternatorTool"/> | |
</toolbox> | |
</tools> | |
template... | |
#set( $color = $alternator.auto('red', 'blue') ) | |
## use manual alternation for this one | |
#set( $style = $alternator.manual('hip','fly','groovy') ) | |
#foreach( $i in [1..5] ) | |
Number $i is $color and $style. I dig $style.next numbers. | |
#end * | |
output... | |
Number 1 is red and hip. I dig hip numbers. | |
Number 2 is blue and fly. I dig fly numbers. | |
Number 3 is red and groovy. I dig groovy numbers. | |
Number 4 is blue and hip. I dig hip numbers. | |
Number 5 is red and fly. I dig fly numbers. | |
</pre></p> | |
<P> | |
<P> | |
<DL> | |
<DT><B>Since:</B></DT> | |
<DD>Velocity Tools 1.2</DD> | |
<DT><B>Version:</B></DT> | |
<DD>$Revision: 671010 $ $Date: 2008-06-23 20:40:41 -0700 (Mon, 23 Jun 2008) $</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>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#AUTO_ALTERNATE_DEFAULT_KEY">AUTO_ALTERNATE_DEFAULT_KEY</A></B></CODE> | |
<BR> | |
</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/AlternatorTool.html#autoAlternateDefault">autoAlternateDefault</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/AlternatorTool.html#OLD_AUTO_ALTERNATE_DEFAULT_KEY">OLD_AUTO_ALTERNATE_DEFAULT_KEY</A></B></CODE> | |
<BR> | |
<B>Deprecated.</B> </TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#OLD_LOCK_CONFIG_KEY">OLD_LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></CODE></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/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#auto(java.util.Collection)">auto</A></B>(java.util.Collection list)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></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#auto(java.lang.Object...)">auto</A></B>(java.lang.Object... 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 the 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#auto(java.lang.Object, java.lang.Object)">auto</A></B>(java.lang.Object o1, | |
java.lang.Object o2)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> parser)</CODE> | |
<BR> | |
Looks for a default auto-alternate value in the given params, | |
if not, set the default to true.</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/AlternatorTool.html#getAutoAlternateDefault()">getAutoAlternateDefault</A></B>()</CODE> | |
<BR> | |
Returns true if the default for auto-alternating is true.</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.util.Collection)">make</A></B>(boolean auto, | |
java.util.Collection list)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></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... list)</CODE> | |
<BR> | |
Returns a new Alternator for the specified list with the specified | |
automatic shifting preference.</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> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></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.Collection)">make</A></B>(java.util.Collection list)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></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... 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 the specifed 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.lang.Object, java.lang.Object)">make</A></B>(java.lang.Object o1, | |
java.lang.Object o2)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></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#manual(java.util.Collection)">manual</A></B>(java.util.Collection list)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></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#manual(java.lang.Object...)">manual</A></B>(java.lang.Object... list)</CODE> | |
<BR> | |
Make a manual <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from the 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#manual(java.lang.Object, java.lang.Object)">manual</A></B>(java.lang.Object o1, | |
java.lang.Object o2)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/AlternatorTool.html#setAutoAlternateDefault(boolean)">setAutoAlternateDefault</A></B>(boolean bool)</CODE> | |
<BR> | |
Sets the default for auto-alternating.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(java.util.Map)">configure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked()">isConfigLocked</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode()">isSafeMode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig(boolean)">setLockConfig</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode(boolean)">setSafeMode</A></CODE></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> | |
<!-- ============ 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="OLD_AUTO_ALTERNATE_DEFAULT_KEY"><!-- --></A><H3> | |
OLD_AUTO_ALTERNATE_DEFAULT_KEY</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public static final java.lang.String <B>OLD_AUTO_ALTERNATE_DEFAULT_KEY</B></PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.AlternatorTool.OLD_AUTO_ALTERNATE_DEFAULT_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="AUTO_ALTERNATE_DEFAULT_KEY"><!-- --></A><H3> | |
AUTO_ALTERNATE_DEFAULT_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>AUTO_ALTERNATE_DEFAULT_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.AlternatorTool.AUTO_ALTERNATE_DEFAULT_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="autoAlternateDefault"><!-- --></A><H3> | |
autoAlternateDefault</H3> | |
<PRE> | |
private boolean <B>autoAlternateDefault</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="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="configure(org.apache.velocity.tools.generic.ValueParser)"><!-- --></A><H3> | |
configure</H3> | |
<PRE> | |
protected void <B>configure</B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> parser)</PRE> | |
<DL> | |
<DD>Looks for a default auto-alternate value in the given params, | |
if not, set the default to true. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAutoAlternateDefault()"><!-- --></A><H3> | |
getAutoAlternateDefault</H3> | |
<PRE> | |
public boolean <B>getAutoAlternateDefault</B>()</PRE> | |
<DL> | |
<DD>Returns true if the default for auto-alternating is true. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>VelocityTools 1.3</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setAutoAlternateDefault(boolean)"><!-- --></A><H3> | |
setAutoAlternateDefault</H3> | |
<PRE> | |
protected void <B>setAutoAlternateDefault</B>(boolean bool)</PRE> | |
<DL> | |
<DD>Sets the default for auto-alternating. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>VelocityTools 1.3</DD> | |
</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... 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 the specifed objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="make(java.util.Collection)"><!-- --></A><H3> | |
make</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>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.Collection list)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<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... list)</PRE> | |
<DL> | |
<DD>Returns a new Alternator for the specified list with the specified | |
automatic shifting preference. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>auto</CODE> - See <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html#setAuto(boolean)"><CODE>Alternator.setAuto(boolean auto)</CODE></A>.<DD><CODE>list</CODE> - The list of elements to alternate.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="make(boolean, java.util.Collection)"><!-- --></A><H3> | |
make</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>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.Collection list)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="make(java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
make</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>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><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="make(boolean, java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
make</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>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><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="auto(java.lang.Object...)"><!-- --></A><H3> | |
auto</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>auto</B>(java.lang.Object... 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 the specified objects. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>a new, automatic Alternator with the specified values or | |
<code>null</code> if there are none specified.<DT><B>Since:</B></DT> | |
<DD>VelocityTools 1.3</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="auto(java.util.Collection)"><!-- --></A><H3> | |
auto</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>auto</B>(java.util.Collection list)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="auto(java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
auto</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>auto</B>(java.lang.Object o1, | |
java.lang.Object o2)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="manual(java.lang.Object...)"><!-- --></A><H3> | |
manual</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>manual</B>(java.lang.Object... list)</PRE> | |
<DL> | |
<DD>Make a manual <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic"><CODE>Alternator</CODE></A> from the specified objects. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>a new, manual Alternator with the values in the array or | |
<code>null</code> if the array is <code>null</code>.<DT><B>Since:</B></DT> | |
<DD>VelocityTools 1.3</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="manual(java.util.Collection)"><!-- --></A><H3> | |
manual</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>manual</B>(java.util.Collection list)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="manual(java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
manual</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public <A HREF="../../../../../org/apache/velocity/tools/generic/Alternator.html" title="class in org.apache.velocity.tools.generic">Alternator</A> <B>manual</B>(java.lang.Object o1, | |
java.lang.Object o2)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<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"> | |
<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/ClassTool.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 | <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-2007 Apache Software Foundation | |
</BODY> | |
</HTML> |