Class AlternatorTool
java.lang.Object
org.apache.velocity.tools.generic.SafeConfig
org.apache.velocity.tools.generic.AlternatorTool
Simple tool to provide easy in-template instantiation of
Alternator
s from varying "list" types or individual
arguments.
Example Use:
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.
- Since:
- Velocity Tools 1.2
- Version:
- $Revision: 671010 $ $Date: 2008-06-23 20:40:41 -0700 (Mon, 23 Jun 2008) $
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
private boolean
static final String
Deprecated.Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionMake an automaticAlternator
from the specified objects.Deprecated.Will be unnecessary with Velocity 1.6auto
(Collection list) Deprecated.Will be unnecessary with Velocity 1.6protected void
configure
(ValueParser parser) Looks for a default auto-alternate value in the given params, if not, set the default to true.boolean
Returns true if the default for auto-alternating is true.Returns a new Alternator for the specified list with the specified automatic shifting preference.Deprecated.Will be unnecessary with Velocity 1.6make
(boolean auto, Collection list) Deprecated.Will be unnecessary with Velocity 1.6Make an automaticAlternator
from the specifed objects.Deprecated.Will be unnecessary with Velocity 1.6make
(Collection list) Deprecated.Will be unnecessary with Velocity 1.6Make a manualAlternator
from the specified objects.Deprecated.Will be unnecessary with Velocity 1.6manual
(Collection list) Deprecated.Will be unnecessary with Velocity 1.6protected void
setAutoAlternateDefault
(boolean bool) Sets the default for auto-alternating.Methods inherited from class org.apache.velocity.tools.generic.SafeConfig
configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode
-
Field Details
-
OLD_AUTO_ALTERNATE_DEFAULT_KEY
Deprecated.- See Also:
-
AUTO_ALTERNATE_DEFAULT_KEY
- See Also:
-
autoAlternateDefault
private boolean autoAlternateDefault
-
-
Constructor Details
-
AlternatorTool
public AlternatorTool()
-
-
Method Details
-
configure
Looks for a default auto-alternate value in the given params, if not, set the default to true.- Overrides:
configure
in classSafeConfig
-
getAutoAlternateDefault
public boolean getAutoAlternateDefault()Returns true if the default for auto-alternating is true.- Since:
- VelocityTools 1.3
-
setAutoAlternateDefault
protected void setAutoAlternateDefault(boolean bool) Sets the default for auto-alternating.- Since:
- VelocityTools 1.3
-
make
Make an automaticAlternator
from the specifed objects. -
make
Deprecated.Will be unnecessary with Velocity 1.6 -
make
Returns a new Alternator for the specified list with the specified automatic shifting preference.- Parameters:
auto
- SeeAlternator.setAuto(boolean auto)
.list
- The list of elements to alternate.
-
make
Deprecated.Will be unnecessary with Velocity 1.6 -
make
Deprecated.Will be unnecessary with Velocity 1.6 -
make
Deprecated.Will be unnecessary with Velocity 1.6 -
auto
Make an automaticAlternator
from the specified objects.- Returns:
- a new, automatic Alternator with the specified values or
null
if there are none specified. - Since:
- VelocityTools 1.3
-
auto
Deprecated.Will be unnecessary with Velocity 1.6 -
auto
Deprecated.Will be unnecessary with Velocity 1.6 -
manual
Make a manualAlternator
from the specified objects.- Returns:
- a new, manual Alternator with the values in the array or
null
if the array isnull
. - Since:
- VelocityTools 1.3
-
manual
Deprecated.Will be unnecessary with Velocity 1.6 -
manual
Deprecated.Will be unnecessary with Velocity 1.6
-