@DefaultKey(value="alternator") public class AlternatorTool extends SafeConfig
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.
Modifier and Type | Field and Description |
---|---|
static String |
AUTO_ALTERNATE_DEFAULT_KEY |
static String |
OLD_AUTO_ALTERNATE_DEFAULT_KEY
Deprecated.
|
LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY
Constructor and Description |
---|
AlternatorTool() |
Modifier and Type | Method and Description |
---|---|
Alternator |
auto(Collection list)
Deprecated.
Will be unnecessary with Velocity 1.6
|
Alternator |
auto(Object... list)
Make an automatic
Alternator from the specified objects. |
Alternator |
auto(Object o1,
Object o2)
Deprecated.
Will be unnecessary with Velocity 1.6
|
protected void |
configure(ValueParser parser)
Looks for a default auto-alternate value in the given params,
if not, set the default to true.
|
boolean |
getAutoAlternateDefault()
Returns true if the default for auto-alternating is true.
|
Alternator |
make(boolean auto,
Collection list)
Deprecated.
Will be unnecessary with Velocity 1.6
|
Alternator |
make(boolean auto,
Object... list)
Returns a new Alternator for the specified list with the specified
automatic shifting preference.
|
Alternator |
make(boolean auto,
Object o1,
Object o2)
Deprecated.
Will be unnecessary with Velocity 1.6
|
Alternator |
make(Collection list)
Deprecated.
Will be unnecessary with Velocity 1.6
|
Alternator |
make(Object... list)
Make an automatic
Alternator from the specifed objects. |
Alternator |
make(Object o1,
Object o2)
Deprecated.
Will be unnecessary with Velocity 1.6
|
Alternator |
manual(Collection list)
Deprecated.
Will be unnecessary with Velocity 1.6
|
Alternator |
manual(Object... list)
Make a manual
Alternator from the specified objects. |
Alternator |
manual(Object o1,
Object o2)
Deprecated.
Will be unnecessary with Velocity 1.6
|
protected void |
setAutoAlternateDefault(boolean bool)
Sets the default for auto-alternating.
|
configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode
@Deprecated public static final String OLD_AUTO_ALTERNATE_DEFAULT_KEY
public static final String AUTO_ALTERNATE_DEFAULT_KEY
protected void configure(ValueParser parser)
configure
in class SafeConfig
public boolean getAutoAlternateDefault()
protected void setAutoAlternateDefault(boolean bool)
public Alternator make(Object... list)
Alternator
from the specifed objects.@Deprecated public Alternator make(Collection list)
public Alternator make(boolean auto, Object... list)
auto
- See Alternator.setAuto(boolean auto)
.list
- The list of elements to alternate.@Deprecated public Alternator make(boolean auto, Collection list)
@Deprecated public Alternator make(Object o1, Object o2)
@Deprecated public Alternator make(boolean auto, Object o1, Object o2)
public Alternator auto(Object... list)
Alternator
from the specified objects.null
if there are none specified.@Deprecated public Alternator auto(Collection list)
@Deprecated public Alternator auto(Object o1, Object o2)
public Alternator manual(Object... list)
Alternator
from the specified objects.null
if the array is null
.@Deprecated public Alternator manual(Collection list)
@Deprecated public Alternator manual(Object o1, Object o2)
Copyright © 2002–2014 Apache Software Foundation. All rights reserved.