|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.betwixt.expression.IteratorExpression.ArrayIterator
private static final class IteratorExpression.ArrayIterator
ArrayIterator
originated in commons-collections. Added
as a private inner class to break dependency.
Field Summary | |
---|---|
protected java.lang.Object |
array
The array to iterate over |
protected int |
endIndex
The end index to loop to |
protected int |
index
The current iterator index |
protected int |
startIndex
The start index to loop from |
Constructor Summary | |
---|---|
IteratorExpression.ArrayIterator()
Constructor for use with setArray . |
|
IteratorExpression.ArrayIterator(java.lang.Object array)
Constructs an ArrayIterator that will iterate over the values in the specified array. |
|
IteratorExpression.ArrayIterator(java.lang.Object array,
int startIndex)
Constructs an ArrayIterator that will iterate over the values in the specified array from a specific start index. |
|
IteratorExpression.ArrayIterator(java.lang.Object array,
int startIndex,
int endIndex)
Construct an ArrayIterator that will iterate over a range of values in the specified array. |
Method Summary | |
---|---|
protected void |
checkBound(int bound,
java.lang.String type)
Checks whether the index is valid or not. |
java.lang.Object |
getArray()
Gets the array that this iterator is iterating over. |
boolean |
hasNext()
Returns true if there are more elements to return from the array. |
java.lang.Object |
next()
Returns the next element in the array. |
void |
remove()
Throws UnsupportedOperationException . |
void |
reset()
Resets the iterator back to the start index. |
void |
setArray(java.lang.Object array)
Sets the array that the ArrayIterator should iterate over. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.Object array
protected int startIndex
protected int endIndex
protected int index
Constructor Detail |
---|
public IteratorExpression.ArrayIterator()
setArray
.
Using this constructor, the iterator is equivalent to an empty
iterator until setArray(Object)
is called to establish the
array to iterate over.
public IteratorExpression.ArrayIterator(java.lang.Object array)
array
- the array to iterate over.
java.lang.IllegalArgumentException
- if array
is not an array.
java.lang.NullPointerException
- if array
is null
public IteratorExpression.ArrayIterator(java.lang.Object array, int startIndex)
array
- the array to iterate over.startIndex
- the index to start iterating at.
java.lang.IllegalArgumentException
- if array
is not an array.
java.lang.NullPointerException
- if array
is null
java.lang.IndexOutOfBoundsException
- if the index is invalidpublic IteratorExpression.ArrayIterator(java.lang.Object array, int startIndex, int endIndex)
array
- the array to iterate over.startIndex
- the index to start iterating at.endIndex
- the index to finish iterating at.
java.lang.IllegalArgumentException
- if array
is not an array.
java.lang.NullPointerException
- if array
is null
java.lang.IndexOutOfBoundsException
- if either index is invalidMethod Detail |
---|
protected void checkBound(int bound, java.lang.String type)
bound
- the index to checktype
- the index type (for error messages)
java.lang.IndexOutOfBoundsException
- if the index is invalidpublic boolean hasNext()
hasNext
in interface java.util.Iterator
public java.lang.Object next()
next
in interface java.util.Iterator
java.util.NoSuchElementException
- if all the elements in the array have already been
returnedpublic void remove()
UnsupportedOperationException
.
remove
in interface java.util.Iterator
java.lang.UnsupportedOperationException
- alwayspublic java.lang.Object getArray()
null
if the no-arg constructor was used and
setArray(Object)
has never been called with a valid
array.public void setArray(java.lang.Object array)
If an array has previously been set (using the single-arg constructor
or this method) then that array is discarded in favour of this one.
Iteration is restarted at the start of the new array. Although this
can be used to reset iteration, the reset()
method is a more
effective choice.
array
- the array that the iterator should iterate over.
java.lang.IllegalArgumentException
- if array
is not an array.
java.lang.NullPointerException
- if array
is null
public void reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |