org.jmlspecs.jmlunit.strategies
Class LongAbstractFilteringIteratorDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.LongAbstractIterator
      org.jmlspecs.jmlunit.strategies.LongAbstractFilteringIteratorDecorator

All Implemented Interfaces:

Cloneable, IndefiniteIterator, LongIterator

Direct Known Subclasses:

LongAbstractFilteringStrategyDecorator.NewIter, LongNonNegativeIteratorDecorator

public abstract class LongAbstractFilteringIteratorDecorator

extends LongAbstractIterator

An filtering decorator for an indefinite iterator over type long.

Author:

Gary T. Leavens

Field Summary
private  LongIterator	rawElems

 

Constructor Summary

LongAbstractFilteringIteratorDecorator(LongIterator iter)           Initialize this iterator decorator

LongAbstractFilteringIteratorDecorator(LongIterator iter, long 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(long elem)           Return true if the element is to be returned by the getLong() method.
boolean	atEnd()           Is this iterator at its end?
Object	clone()           Return a copy of this iterator in the same state as this object.
long	getLong()           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.LongAbstractIterator

get

 

Methods inherited from class java.lang.Object

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

 

Field Detail

rawElems

private LongIterator rawElems

LongAbstractFilteringIteratorDecorator

public LongAbstractFilteringIteratorDecorator(LongIterator iter)

Initialize this iterator decorator

LongAbstractFilteringIteratorDecorator

public LongAbstractFilteringIteratorDecorator(LongIterator iter,
                                              long 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(long elem)

Return true if the element is to be returned by the getLong() 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?

getLong

public long getLong()
             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: LongIterator

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

Specified by:

clone in interface LongIterator

Overrides:

clone in class LongAbstractIterator

toString

public String toString()

Overrides:

toString in class Object