| javax.servlet.jsp.jstl.core.LoopTagStatus
| LoopTagStatus | | public interface LoopTagStatus (Code) | | Exposes the current status of
an iteration. JSTL provides a mechanism for LoopTags to
return information about the current index of the iteration and
convenience methods to determine whether or not the current round is
either the first or last in the iteration. It also lets authors
use the status object to obtain information about the iteration range,
step, and current object.
Environments that require more status can extend this interface.
author:
Shawn Bayern |
| Method Summary | |
| public Integer | getBegin()
Returns the value of the 'begin' attribute for the associated tag,
or null if no 'begin' attribute was specified. | | public int | getCount()
Retrieves the "count" of the current round of the iteration. | | public Object | getCurrent()
Retrieves the current item in the iteration. | | public Integer | getEnd()
Returns the value of the 'end' attribute for the associated tag,
or null if no 'end' attribute was specified. | | public int | getIndex()
Retrieves the index of the current round of the iteration. | | public Integer | getStep()
Returns the value of the 'step' attribute for the associated tag,
or null if no 'step' attribute was specified. | | public boolean | isFirst()
Returns information about whether the current round of the
iteration is the first one. | | public boolean | isLast()
Returns information about whether the current round of the
iteration is the last one. |
| getBegin | | public Integer getBegin()(Code) | | Returns the value of the 'begin' attribute for the associated tag,
or null if no 'begin' attribute was specified.
the 'begin' value for the associated tag, or nullif no 'begin' attribute was specified |
| getCount | | public int getCount()(Code) | | Retrieves the "count" of the current round of the iteration. The
count is a relative, 1-based sequence number identifying the
current "round" of iteration (in context with all rounds the
current iteration will perform).
As an example, an iteration with begin = 5, end = 15, and step =
5 produces the counts 1, 2, and 3 in that order.
the 1-based count of the current round of the iteration |
| getCurrent | | public Object getCurrent()(Code) | | Retrieves the current item in the iteration. Behaves
idempotently; calling getCurrent() repeatedly should return the same
Object until the iteration is advanced. (Specifically, calling
getCurrent() does not advance the iteration.)
the current item as an object |
| getEnd | | public Integer getEnd()(Code) | | Returns the value of the 'end' attribute for the associated tag,
or null if no 'end' attribute was specified.
the 'end' value for the associated tag, or nullif no 'end' attribute was specified |
| getIndex | | public int getIndex()(Code) | | Retrieves the index of the current round of the iteration. If
iteration is being performed over a subset of an underlying
array, java.lang.Collection, or other type, the index returned
is absolute with respect to the underlying collection. Indices
are 0-based.
the 0-based index of the current round of the iteration |
| getStep | | public Integer getStep()(Code) | | Returns the value of the 'step' attribute for the associated tag,
or null if no 'step' attribute was specified.
the 'step' value for the associated tag, or nullif no 'step' attribute was specified |
| isFirst | | public boolean isFirst()(Code) | | Returns information about whether the current round of the
iteration is the first one. This current round may be the 'first'
even when getIndex() != 0, for 'index' refers to the absolute
index of the current 'item' in the context of its underlying
collection. It is always that case that a true result from
isFirst() implies getCount() == 1.
true if the current round is the first in theiteration, false otherwise. |
| isLast | | public boolean isLast()(Code) | | Returns information about whether the current round of the
iteration is the last one. As with isFirst(), subsetting is
taken into account. isLast() doesn't necessarily refer to the
status of the underlying Iterator; it refers to whether or not
the current round will be the final round of iteration for the
tag associated with this LoopTagStatus.
true if the current round is the last in theiteration, false otherwise. |
|
|