org.jmlspecs.jmlunit.strategies
Class CompositeIterator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.CompositeIterator

All Implemented Interfaces:

Cloneable, IndefiniteIterator

public class CompositeIterator

extends Object

implements IndefiniteIterator

Composition of several indefinite iterators.

Author:

Gary T. Leavens

See Also:

IndefiniteIterator

Field Summary
private  int	currentIterator           What iterator we are working with now.
private  IndefiniteIterator[]	iters           The iterators that are being sequenced

 

Constructor Summary
protected	CompositeIterator(int currentIterator, IndefiniteIterator[] iters)           Initialize this composite to iterate over clones of the given iterators, in order, starting at the given current iterator.
	CompositeIterator(IndefiniteIterator iter)           Initialize this composite to iterate over the given iterator.
	CompositeIterator(IndefiniteIterator iter1, IndefiniteIterator iter2)           Initialize this composite to iterate over the given iterators, in order.
	CompositeIterator(IndefiniteIterator[] iters)           Initialize this composite to iterate over clones of the given iterators, in order.

 

Method Summary
void	advance()           Advance the state of this iteration to the next position.
boolean	atEnd()           Is this iterator at its end?
Object	clone()           Return a copy of this iterator in the same state as this object.
Object	get()           Return the next element in this iteration.
private  void	setCurrentIterator()           Set the current iterator to the next one that has elements, if any.
String	toString()

 

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

currentIterator

private int currentIterator

What iterator we are working with now.

iters

private final IndefiniteIterator[] iters

The iterators that are being sequenced

CompositeIterator

public CompositeIterator(IndefiniteIterator iter)

Initialize this composite to iterate over the given iterator.

CompositeIterator

public CompositeIterator(IndefiniteIterator iter1,
                         IndefiniteIterator iter2)

Initialize this composite to iterate over the given iterators, in order.

CompositeIterator

public CompositeIterator(IndefiniteIterator[] iters)

Initialize this composite to iterate over clones of the given iterators, in order.

CompositeIterator

protected CompositeIterator(int currentIterator,
                            IndefiniteIterator[] iters)

Initialize this composite to iterate over clones of the given iterators, in order, starting at the given current iterator.

atEnd

public boolean atEnd()

Description copied from interface: IndefiniteIterator

Is this iterator at its end? That is, if we called get(), would it throw an exception?

Specified by:

atEnd in interface IndefiniteIterator

get

public Object get()

Return the next element in this iteration.

Specified by:

get in interface IndefiniteIterator

Throws:

NoSuchElementException;

advance

public void advance()

Description copied from interface: IndefiniteIterator

Advance the state of this iteration to the next position. Note that this never throws an exception.

Specified by:

advance in interface IndefiniteIterator

setCurrentIterator

private void setCurrentIterator()

Set the current iterator to the next one that has elements, if any.

clone

public Object clone()

Description copied from interface: IndefiniteIterator

Return a copy of this iterator in the same state as this object.

Specified by:

clone in interface IndefiniteIterator

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object