org.jmlspecs.jmlunit.strategies
Class ShortAbstractFilteringIteratorDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.ShortAbstractIterator
      org.jmlspecs.jmlunit.strategies.ShortAbstractFilteringIteratorDecorator

All Implemented Interfaces:

Cloneable, IndefiniteIterator, ShortIterator

Direct Known Subclasses:

ShortAbstractFilteringStrategyDecorator.NewIter, ShortNonNegativeIteratorDecorator

public abstract class ShortAbstractFilteringIteratorDecorator

extends ShortAbstractIterator

An filtering decorator for an indefinite iterator over type short.

Author:

Gary T. Leavens

Field Summary
private  ShortIterator	rawElems

 

Constructor Summary

ShortAbstractFilteringIteratorDecorator(ShortIterator iter)           Initialize this iterator decorator

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

get

 

Methods inherited from class java.lang.Object

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

 

Field Detail

rawElems

private ShortIterator rawElems

ShortAbstractFilteringIteratorDecorator

public ShortAbstractFilteringIteratorDecorator(ShortIterator iter)

Initialize this iterator decorator

ShortAbstractFilteringIteratorDecorator

public ShortAbstractFilteringIteratorDecorator(ShortIterator iter,
                                               short 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(short elem)

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

getShort

public short getShort()
               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: ShortIterator

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

Specified by:

clone in interface ShortIterator

Overrides:

clone in class ShortAbstractIterator

toString

public String toString()

Overrides:

toString in class Object