|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.velocity.tools.generic.ListTool
Tool for working with Lists and arrays in Velocity templates. It provides a method to get and set specified elements. Also provides methods to perform the following actions to Lists and arrays:
Example uses: $primes -> new int[] {2, 3, 5, 7} $list.size($primes) -> 4 $list.get($primes, 2) -> 5 $list.set($primes, 2, 1) -> (primes[2] becomes 1) $list.get($primes, 2) -> 1 $list.isEmpty($primes) -> false $list.contains($primes, 7) -> true Example toolbox.xml config (if you want to use this with VelocityView): <tool> <key>list</key> <scope>application</scope> <class>org.apache.velocity.tools.generic.ListTool</class> </tool>
This tool is entirely threadsafe, and has no instance members. It may be used in any scope (request, session, or application).
Constructor Summary | |
ListTool()
Default constructor. |
Method Summary | |
java.lang.Boolean |
contains(java.lang.Object list,
java.lang.Object element)
Checks if a List/array contains a certain element. |
java.lang.Object |
get(java.lang.Object list,
int index)
Gets the specified element of a List/array. |
boolean |
isArray(java.lang.Object object)
Checks if an object is an array. |
java.lang.Boolean |
isEmpty(java.lang.Object list)
Checks if a List/array is empty. |
boolean |
isList(java.lang.Object object)
Checks if an object is a List. |
java.lang.Object |
set(java.lang.Object list,
int index,
java.lang.Object value)
Sets the specified element of a List/array. |
java.lang.Integer |
size(java.lang.Object list)
Gets the size of a List/array. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ListTool()
Method Detail |
public java.lang.Object get(java.lang.Object list, int index)
list
is null.list
is not a List/array.list
doesn't have an index
th value.
list
- the List/array object.index
- the index of the List/array to get.
public java.lang.Object set(java.lang.Object list, int index, java.lang.Object value)
list
is null.list
is not a List/array.list
doesn't have an index
th value.
list
- the List/array object.index
- the index of the List/array to set.value
- the element to set.
public java.lang.Integer size(java.lang.Object list)
list
is null.list
is not a List/array.#length(Object)
method.
list
- the List object.
#length(Object)
public boolean isArray(java.lang.Object object)
object
- the object to check.
true
if the object is an array.public boolean isList(java.lang.Object object)
object
- the object to check.
true
if the object is a List.public java.lang.Boolean isEmpty(java.lang.Object list)
list
- the List/array to check.
true
if the List/array is empty.public java.lang.Boolean contains(java.lang.Object list, java.lang.Object element)
list
- the List/array to check.element
- the element to check.
true
if the List/array contains the element.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |