Top Description Fields Constructors Methods
org.wildfly.common.iteration

public Class CompositeIterator<E>

extends Object
implements Iterator<E>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Imports
java.util.Arrays, .Iterator, .NoSuchElementException, java.util.function.Consumer
Iterator that iterates over a series of iterators.
Author
Paul Ferraro

Field Summary

Modifier and TypeField and Description
private final Iterable<? extends Iterator<? extends E>>
iterators

private Iterator<? extends E>
lastIterator

Constructor Summary

AccessConstructor and Description
public
CompositeIterator(Iterator<? extends E>...
a series of iterators
iterators)

Constructs a new composite iterator.

public
CompositeIterator(Iterable<? extends Iterator<? extends E>>
a series of iterators
iterators)

Constructs a new composite iterator.

Method Summary

Modifier and TypeMethod and Description
public void
forEachRemaining(Consumer<? super E>
The action to be performed for each element
action)

Overrides default java.util.Iterator.forEachRemaining.

Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.
public E
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

iteratorsback to summary
private final Iterable<? extends Iterator<? extends E>> iterators
lastIteratorback to summary
private Iterator<? extends E> lastIterator

Constructor Detail

CompositeIteratorback to summary
public CompositeIterator(Iterator<? extends E>... iterators)

Constructs a new composite iterator.

Parameters
iterators:Iterator<? extends E>[]

a series of iterators

Annotations
@SafeVarargs
CompositeIteratorback to summary
public CompositeIterator(Iterable<? extends Iterator<? extends E>> iterators)

Constructs a new composite iterator.

Parameters
iterators:Iterable<? extends Iterator<? extends E>>

a series of iterators

Method Detail

forEachRemainingback to summary
public void forEachRemaining(Consumer<? super E> action)

Overrides default java.util.Iterator.forEachRemaining.

Doc from java.util.Iterator.forEachRemaining.

Performs the given action for each remaining element until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The behavior of an iterator is unspecified if the action modifies the collection in any way (even by calling the remove method or other mutator methods of Iterator subtypes), unless an overriding class has specified a concurrent modification policy.

Subsequent behavior of an iterator is unspecified if the action throws an exception.

Parameters
action:Consumer<? super E>

The action to be performed for each element

Annotations
@Override
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 E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

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