com.tangosol.util
Interface LongArray.Iterator

All Superinterfaces:

Iterator

All Known Implementing Classes:

SimpleLongArray.Iterator, SparseArray.Crawler

Enclosing interface:

LongArray

public static interface LongArray.Iterator
extends Iterator

An Iterator that adds a "current element" concept, similar to the Map.Entry interface.

Method Summary

long	getIndex() Returns the index of the current value, which is the value returned by the most recent call to the next method.
Object	getValue() Returns the current value, which is the same value returned by the most recent call to the next method, or the most recent value passed to setValue if setValue were called after the next method.
boolean	hasNext() Returns true if the iteration has more elements.
Object	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).
Object	setValue(Object oValue) Stores a new value at the current value index, returning the value that was replaced.

Method Detail

hasNext

boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator

Returns:

true if the iterator has more elements

next

Object next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator

Returns:

the next element in the iteration

Throws:

NoSuchElementException - iteration has no more elements

getIndex

long getIndex()

Returns the index of the current value, which is the value returned by the most recent call to the next method.

Throws:

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

getValue

Object getValue()

Returns the current value, which is the same value returned by the most recent call to the next method, or the most recent value passed to setValue if setValue were called after the next method.

Returns:

the current value

Throws:

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

setValue

Object setValue(Object oValue)

Stores a new value at the current value index, returning the value that was replaced. The index of the current value is obtainable by calling the getIndex method.

Returns:

the replaced value

Throws:

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

remove

void remove()

Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Specified by:

remove in interface Iterator

Throws:

UnsupportedOperationException - if the remove operation is not supported by this Iterator

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.