JML

org.jmlspecs.jmlunit.strategies
Class CharCompositeIterator

java.lang.Object
  extended byorg.jmlspecs.jmlunit.strategies.CharAbstractIterator
      extended byorg.jmlspecs.jmlunit.strategies.CharCompositeIterator
All Implemented Interfaces:
CharIterator, Cloneable, IndefiniteIterator

public class CharCompositeIterator
extends CharAbstractIterator

Composition of several CharIterators.

Author:
Gary T. Leavens
See Also:
CharIterator

Field Summary
private  int currentIterator
          What iterator we are working with now.
private  CharIterator[] iters
          The iterators that are being sequenced
 
Constructor Summary
protected CharCompositeIterator(int currentIterator, CharIterator[] iters)
          Initialize this composite to iterate over clones of the given iterators, in order, starting at the given current iterator.
  CharCompositeIterator(CharIterator iter)
          Initialize this composite to iterate over the given iterator.
  CharCompositeIterator(CharIterator iter1, CharIterator iter2)
          Initialize this composite to iterate over the given iterators, in order.
  CharCompositeIterator(CharIterator[] 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.
 char getChar()
          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 org.jmlspecs.jmlunit.strategies.CharAbstractIterator
get
 
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 CharIterator[] iters
The iterators that are being sequenced

Constructor Detail

CharCompositeIterator

public CharCompositeIterator(CharIterator iter)
Initialize this composite to iterate over the given iterator.


CharCompositeIterator

public CharCompositeIterator(CharIterator iter1,
                             CharIterator iter2)
Initialize this composite to iterate over the given iterators, in order.


CharCompositeIterator

public CharCompositeIterator(CharIterator[] iters)
Initialize this composite to iterate over clones of the given iterators, in order.


CharCompositeIterator

protected CharCompositeIterator(int currentIterator,
                                CharIterator[] iters)
Initialize this composite to iterate over clones of the given iterators, in order, starting at the given current iterator.

Method Detail

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?


getChar

public char getChar()
             throws NoSuchElementException
Return the next element in this iteration.

Throws:
NoSuchElementException;
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.


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: CharIterator
Return a copy of this iterator in the same state as this object.

Specified by:
clone in interface CharIterator
Overrides:
clone in class CharAbstractIterator

toString

public String toString()
Overrides:
toString in class Object

JML

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.