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

public Class MultiIterator<T>

extends Object
implements Iterator<T>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Type Parameters
<T>
The element type of the iterator
Imports
java.util.Arrays, .Collection, .Collections, .Iterator, .NoSuchElementException, org.codehaus.commons.compiler.InternalCompilerException
An java.util.Iterator that traverses a java.util.Collection of java.util.Iterators, Collections and/or arrays.

Field Summary

Modifier and TypeField and Description
private Iterator<T>
inner

private final Iterator<?>
outer

Constructor Summary

AccessConstructor and Description
public
MultiIterator(Iterator<T>[]
An array of Iterators
iterators)

public
MultiIterator(Collection<T>[]
An array of Collections
collections)

public
MultiIterator(Object[][]
An array of arrays
arrays)

public
MultiIterator(Collection<?>
A Collection of Collections, Iterators and/or arrays
collection)

public
MultiIterator(Iterator<?>
An iterator over Collections, Iterators and/or arrays
iterator)

public
MultiIterator(Object[]
An array of Collections, Iterators and/or arrays
array)

public
MultiIterator(Object object, Collection<T> collection)

Iterates over the given Collection, prepended with the given Object.

public
MultiIterator(Collection<T> collection, Object object)

Iterates over the given Collection, appended with the given Object.

public
MultiIterator(Object prefix, Iterator<T> iterator)

Iterates over the given Iterator, prepended with the given prefix.

public
MultiIterator(Iterator<T> iterator, Object suffix)

Iterates over the given Iterator, appended with the given suffix.

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

innerback to summary
private Iterator<T> inner
outerback to summary
private final Iterator<?> outer

Constructor Detail

MultiIteratorback to summary
public MultiIterator(Iterator<T>[] iterators)
Parameters
iterators:Iterator<T>[]

An array of Iterators

MultiIteratorback to summary
public MultiIterator(Collection<T>[] collections)
Parameters
collections:Collection<T>[]

An array of Collections

MultiIteratorback to summary
public MultiIterator(Object[][] arrays)
Parameters
arrays:Object[][]

An array of arrays

MultiIteratorback to summary
public MultiIterator(Collection<?> collection)
Parameters
collection:Collection<?>

A Collection of Collections, Iterators and/or arrays

MultiIteratorback to summary
public MultiIterator(Iterator<?> iterator)
Parameters
iterator:Iterator<?>

An iterator over Collections, Iterators and/or arrays

MultiIteratorback to summary
public MultiIterator(Object[] array)
Parameters
array:Object[]

An array of Collections, Iterators and/or arrays

MultiIteratorback to summary
public MultiIterator(Object object, Collection<T> collection)

Iterates over the given Collection, prepended with the given Object.

MultiIteratorback to summary
public MultiIterator(Collection<T> collection, Object object)

Iterates over the given Collection, appended with the given Object.

MultiIteratorback to summary
public MultiIterator(Object prefix, Iterator<T> iterator)

Iterates over the given Iterator, prepended with the given prefix.

MultiIteratorback to summary
public MultiIterator(Iterator<T> iterator, Object suffix)

Iterates over the given Iterator, appended with the given suffix.

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