Top Description Fields Constructors Methods
org.codehaus.commons.compiler.util.iterator

public Class MultiDimensionalIterator<T>

extends Object
implements Iterator<T>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Type Parameters
<T>
The type of the objects that the returned iterator produces
Imports
java.util.Arrays, .Collection, .Enumeration, .Iterator, .NoSuchElementException
An java.util.Iterator that iterates over a delegate, which produces arrays, java.util.Collections, java.util.Enumerations or java.util.Iterators. This java.util.Iterator returns the elements of these objects.

The count of dimensions is declared at construction. Count "1" produces an java.util.Iterator that adds no functionality to its delegate, count "2" produces an Iterator that behaves as explained above, and so forth.

Field Summary

Modifier and TypeField and Description
private static final Iterator<Object>
EMPTY_ITERATOR

private final Iterator<?>[]
nest

Constructor Summary

AccessConstructor and Description
public
MultiDimensionalIterator(Iterator<?> delegate, int dimensionCount)

Method Summary

Modifier and TypeMethod and Description
public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.
public T
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.
public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

EMPTY_ITERATORback to summary
private static final Iterator<Object> EMPTY_ITERATOR
nestback to summary
private final Iterator<?>[] nest

Constructor Detail

MultiDimensionalIteratorback to summary
public MultiDimensionalIterator(Iterator<?> delegate, int dimensionCount)

Method Detail

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.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:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public T next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:T

the next element in the iteration

Annotations
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this 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, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override