commons-compiler 3.1.12 · org.codehaus.commons.compiler.util.iterator.TraversingIterator

An java.util.Iterator that iterates over a delegate, and while it encounters an array, a java.util.Collection, an java.util.Enumeration or a java.util.Iterator element, it iterates over it recursively.

Be aware that hasNext() must read ahead one element.

Field Summary

Modifier and Type	Field and Description
private final Stack<Iterator<?>>	nest
private Object	nextElement
private boolean	nextElementRead

Constructor Summary

Access	Constructor and Description
public	TraversingIterator(Iterator<?> delegate)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Object	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
private boolean	Returns: `false` if no more element can be read readNext() Reads the next element and stores it in `nextElement`.
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:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

nest	back to summary
private final Stack<Iterator<?>> nest

nextElement	back to summary
private Object nextElement Annotations @Nullable

nextElementRead	back to summary
private boolean nextElementRead

Constructor Detail

TraversingIterator	back to summary
public TraversingIterator(Iterator<?> delegate)

Method Detail

hasNext back to summary

hasNext	back 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

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

next	back to summary
public Object next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:Object the next element in the iteration Annotations @Override

back to summary

public Object next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Object

the next element in the iteration

Annotations

@Override

readNext back to summary

readNext	back to summary
private boolean readNext() Reads the next element and stores it in `nextElement`. Returns:boolean `false` if no more element can be read

private boolean readNext()

Reads the next element and stores it in nextElement.

Returns:boolean: false if no more element can be read

remove back to summary

remove	back 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 Exceptions UnsupportedOperationException: The `Iterator` currently being traversed doesn't support element removal See Also `Iterator#remove()`

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

Exceptions

UnsupportedOperationException:: The Iterator currently being traversed doesn't support element removal

See Also

Iterator#remove()

public Class TraversingIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail