org.jmlspecs.jmlunit.strategies
Class AbstractFilteringIteratorDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.AbstractFilteringIteratorDecorator

All Implemented Interfaces:

Cloneable, IndefiniteIterator

Direct Known Subclasses:

AbstractFilteringStrategyDecorator.NewIter, NonNullIteratorDecorator

public abstract class AbstractFilteringIteratorDecorator

extends Object

implements IndefiniteIterator

An filtering decorator for an indefinite iterator.

Author:

Gary T. Leavens

Field Summary
private  IndefiniteIterator	rawElems

 

Constructor Summary

AbstractFilteringIteratorDecorator(IndefiniteIterator iter)           Initialize this iterator decorator

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

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

 

Field Detail

rawElems

private IndefiniteIterator rawElems

AbstractFilteringIteratorDecorator

public AbstractFilteringIteratorDecorator(IndefiniteIterator iter)

Initialize this iterator decorator

AbstractFilteringIteratorDecorator

public AbstractFilteringIteratorDecorator(IndefiniteIterator iter,
                                          Object 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(Object elem)

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

Specified by:

atEnd in interface IndefiniteIterator

get

public Object get()
           throws NoSuchElementException

Return the current approved element.

Specified by:

get in interface IndefiniteIterator

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.

Specified by:

advance in interface IndefiniteIterator

clone

public Object clone()

Description copied from interface: IndefiniteIterator

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

Specified by:

clone in interface IndefiniteIterator

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object