choco.util
Interface IntIterator

All Known Implementing Classes:

AbstractIntDomain.IntDomainIterator, BitSetEnumeratedDomain.DeltaDomainIterator, BitSetIntDomain.DeltaIntDomainIterator, Cumulative.IntList, PalmBitSetIntDomain.RepairIntDomainIterator, SetDomainImpl.SetDomainIterator, SetDomainImpl.SetOpenDomainIterator

public interface IntIterator

An interface for collections over native integers. (among other things, this is useful for iterating domains) Note that it does not extend Iterator, as we iterate over native int, and not Object.

Method Summary

boolean	hasNext() Returns true if the iteration has more elements.
int	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by the getIterator (optional operation).

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.)

Returns:

true if the getIterator has more elements.

next

int next()

Returns the next element in the iteration.

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - iteration has no more elements.

remove

void remove()

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

Throws:

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

java.lang.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.