Class ListTool
java.lang.Object
org.apache.velocity.tools.generic.ListTool
Deprecated.
Tool for working with Lists and arrays in Velocity templates.
With the release of Velocity 1.6, this class is largely obsolete since Velocity 1.6 now allows all List methods to be called on arrays within templates.
It provides a method to get and set specified elements. Also provides methods to perform the following actions to Lists and arrays:
- Check if it is empty.
- Check if it contains a certain element.
Example uses: $primes -> new int[] {2, 3, 5, 7} $lists.size($primes) -> 4 $lists.get($primes, 2) -> 5 $lists.set($primes, 2, 1) -> (primes[2] becomes 1) $lists.get($primes, 2) -> 1 $lists.isEmpty($primes) -> false $lists.contains($primes, 7) -> true Example tools.xml config (if you want to use this with VelocityView): <tools> <toolbox scope="application"> <tool class="org.apache.velocity.tools.generic.ListTool"/> </toolbox> </tools>
This tool is entirely threadsafe, and has no instance members. It may be used in any scope (request, session, or application).
- Since:
- VelocityTools 1.2
- Version:
- $Id: $
- Author:
- Shinobu Kawai
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate Boolean
arrayContains
(Object array, Object element) Deprecated.Checks if an array contains a certain element.Deprecated.Checks if a List/array contains a certain element.private boolean
Deprecated.Check if two objects are equal.Deprecated.Gets the specified element of a List/array.private Object
getFromArray
(Object array, int index) Deprecated.Gets the specified element of an array.boolean
Deprecated.Checks if an object is an array.Deprecated.Checks if a List/array is empty.boolean
Deprecated.Checks if an object is a List.Deprecated.Sets the specified element of a List/array.private Object
setToArray
(Object array, int index, Object value) Deprecated.Sets the specified element of an array.Deprecated.Gets the size of a List/array.
-
Constructor Details
-
ListTool
public ListTool()Deprecated.
-
-
Method Details
-
get
Deprecated.Gets the specified element of a List/array. It will return null under the following conditions:list
is null.list
is not a List/array.list
doesn't have anindex
th value.
- Parameters:
list
- the List/array object.index
- the index of the List/array to get.- Returns:
- the specified element of the List/array.
-
getFromArray
Deprecated.Gets the specified element of an array.- Parameters:
array
- the array object.index
- the index of the array to get.- Returns:
- the specified element of the array.
-
set
Deprecated.Sets the specified element of a List/array. It will return null under the following conditions:list
is null.list
is not a List/array.list
doesn't have anindex
th value.
- Parameters:
list
- the List/array object.index
- the index of the List/array to set.value
- the element to set.- Returns:
- blank if set, null if not set.
-
setToArray
Deprecated.Sets the specified element of an array.- Parameters:
array
- the array object.index
- the index of the array to set.value
- the element to set.- Returns:
- blank if set, null if not set.
-
size
Deprecated.Gets the size of a List/array. It will return null under the following conditions:list
is null.list
is not a List/array.
- Parameters:
list
- the List object.- Returns:
- the size of the List.
-
isArray
Deprecated.Checks if an object is an array.- Parameters:
object
- the object to check.- Returns:
true
if the object is an array.
-
isList
Deprecated.Checks if an object is a List.- Parameters:
object
- the object to check.- Returns:
true
if the object is a List.
-
isEmpty
Deprecated.Checks if a List/array is empty.- Parameters:
list
- the List/array to check.- Returns:
true
if the List/array is empty.
-
contains
Deprecated.Checks if a List/array contains a certain element.- Parameters:
list
- the List/array to check.element
- the element to check.- Returns:
true
if the List/array contains the element.
-
arrayContains
Deprecated.Checks if an array contains a certain element.- Parameters:
array
- the array to check.element
- the element to check.- Returns:
true
if the array contains the element.
-
equals
Deprecated.Check if two objects are equal.- Parameters:
what
- an objectwith
- another object.- Returns:
true
if the two objects are equal.
-