org.jmlspecs.jmlunit.strategies
Class IntAbstractFilteringIteratorDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.IntAbstractIterator
      org.jmlspecs.jmlunit.strategies.IntAbstractFilteringIteratorDecorator

All Implemented Interfaces:

Cloneable, IndefiniteIterator, IntIterator

Direct Known Subclasses:

IntAbstractFilteringStrategyDecorator.NewIter, IntNonNegativeIteratorDecorator

public abstract class IntAbstractFilteringIteratorDecorator

extends IntAbstractIterator

An filtering decorator for an indefinite iterator over type int.

Author:

Gary T. Leavens

Field Summary
private  IntIterator	rawElems

 

Constructor Summary

IntAbstractFilteringIteratorDecorator(IntIterator iter)           Initialize this iterator decorator

IntAbstractFilteringIteratorDecorator(IntIterator iter, int ignored)           Partially intialize this iterator decorator, with a call to initialize needed after this call.

 

Method Summary
void	advance()           Advance the state of this iteration to the next position.
abstract  boolean	approve(int elem)           Return true if the element is to be returned by the getInt() method.
boolean	atEnd()           Is this iterator at its end?
Object	clone()           Return a copy of this iterator in the same state as this object.
int	getInt()           Return the current approved element.
void	initialize()           Complete initialization of this object.
private  void	setCursor()           Set the cursor to the next element that is approved, if any.
String	toString()

 

Methods inherited from class org.jmlspecs.jmlunit.strategies.IntAbstractIterator

get

 

Methods inherited from class java.lang.Object

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

 

Field Detail

rawElems

private IntIterator rawElems

IntAbstractFilteringIteratorDecorator

public IntAbstractFilteringIteratorDecorator(IntIterator iter)

Initialize this iterator decorator

IntAbstractFilteringIteratorDecorator

public IntAbstractFilteringIteratorDecorator(IntIterator iter,
                                             int ignored)

Partially intialize this iterator decorator, with a call to initialize needed after this call.

initialize

public void initialize()

Complete initialization of this object.

setCursor

private void setCursor()

Set the cursor to the next element that is approved, if any.

approve

public abstract boolean approve(int elem)

Return true if the element is to be returned by the getInt() method.

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?

getInt

public int getInt()
           throws NoSuchElementException

Return the current approved element.

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.

clone

public Object clone()

Description copied from interface: IntIterator

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

Specified by:

clone in interface IntIterator

Overrides:

clone in class IntAbstractIterator

toString

public String toString()

Overrides:

toString in class Object