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

public Class ProducerIterator<T>

extends Object
implements Iterator<T>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Known Direct Subclasses
org.codehaus.commons.compiler.util.iterator.DirectoryIterator
Type Parameters
<T>
The type of the products and the iterator elements
Imports
java.util.Iterator, .NoSuchElementException, org.codehaus.commons.compiler.util.Producer, org.codehaus.commons.nullanalysis.Nullable

An Iterator that iterates over all the objects produced by a delegate Producer.
See Also
Producer

Field Summary

Modifier and TypeField and Description
private static final Object
private Object
private final Producer<T>
private static final Object

Constructor Summary

AccessConstructor and Description
public

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

AT_ENDback to summary
private static final Object AT_END
Annotations
@Nullable
nextElementback to summary
private Object nextElement
Annotations
@Nullable
producerback to summary
private final Producer<T> producer
UNKNOWNback to summary
private static final Object UNKNOWN

Constructor Detail

ProducerIteratorback to summary
public ProducerIterator(Producer<T> producer)

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