org.jmlspecs.jmlunit.strategies
Class ByteAbstractFilteringIteratorDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.ByteAbstractIterator
      org.jmlspecs.jmlunit.strategies.ByteAbstractFilteringIteratorDecorator

All Implemented Interfaces:

ByteIterator, Cloneable, IndefiniteIterator

Direct Known Subclasses:

ByteAbstractFilteringStrategyDecorator.NewIter, ByteNonNegativeIteratorDecorator

public abstract class ByteAbstractFilteringIteratorDecorator

extends ByteAbstractIterator

An filtering decorator for an indefinite iterator over type byte.

Author:

Gary T. Leavens

Field Summary
private  ByteIterator	rawElems

 

Constructor Summary

ByteAbstractFilteringIteratorDecorator(ByteIterator iter)           Initialize this iterator decorator

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

get

 

Methods inherited from class java.lang.Object

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

 

Field Detail

rawElems

private ByteIterator rawElems

ByteAbstractFilteringIteratorDecorator

public ByteAbstractFilteringIteratorDecorator(ByteIterator iter)

Initialize this iterator decorator

ByteAbstractFilteringIteratorDecorator

public ByteAbstractFilteringIteratorDecorator(ByteIterator iter,
                                              byte 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(byte elem)

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

getByte

public byte getByte()
             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: ByteIterator

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

Specified by:

clone in interface ByteIterator

Overrides:

clone in class ByteAbstractIterator

toString

public String toString()

Overrides:

toString in class Object