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

Class Specifications

public invariant !this.dented ==> (this.atEnd() <==> this.rawElems.atEnd());

Specifications inherited from class Object

represents objectState <- org.jmlspecs.lang.JMLDataGroup.IT; public represents _getClass <- \typeof(this);

Model Field Summary

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Ghost Field Summary
boolean	dented

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Field Summary
[spec_public] private  IndefiniteIterator	rawElems

 

Constructor Summary

AbstractFilteringIteratorDecorator(IndefiniteIterator iter)           Initialize this iterator decorator

AbstractFilteringIteratorDecorator(IndefiniteIterator iter, nullable Object ignored)           Partially intialize this iterator decorator, with a call to initialize needed after this call.

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
void	advance()           Advance the state of this iteration to the next position.
abstract  boolean	approve(nullable 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

 

Ghost Field Detail

dented

public boolean dented

rawElems

private IndefiniteIterator rawElems

Specifications: spec_public non_null
is in groups: objectState
maps rawElems.objectState \into objectState

AbstractFilteringIteratorDecorator

public AbstractFilteringIteratorDecorator(IndefiniteIterator iter)

Initialize this iterator decorator

Specifications:

public normal_behavior
assignable rawElems, objectState, owner;
ensures (* rawElems is a clone of iter *);
ensures this.owner == null;

AbstractFilteringIteratorDecorator

public AbstractFilteringIteratorDecorator(IndefiniteIterator iter,
                                          nullable Object ignored)

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

Specifications:

public normal_behavior
assignable rawElems, dented, owner;
ensures (* rawElems is a clone of iter *)&&this.dented;
ensures this.owner == null;

initialize

public void initialize()

Complete initialization of this object.

Specifications:

assignable objectState, dented;
ensures !this.dented;
ensures !this.atEnd() ==> this.approve(this.get());

setCursor

private void setCursor()

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

Specifications:

assignable objectState;
ensures !this.rawElems.atEnd() ==> this.approve(this.rawElems.get());

approve

public abstract boolean approve(nullable Object elem)

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

Specifications: pure

public normal_behavior
assignable \nothing;

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

Specifications: pure

     also

public normal_behavior
assignable \nothing;
ensures \result == this.rawElems.atEnd();

Specifications inherited from overridden method in interface IndefiniteIterator:
       pure

get

public Object get()
           throws NoSuchElementException

Return the current approved element.

Specified by:

get in interface IndefiniteIterator

Throws:

NoSuchElementException

Specifications: pure nullable

Specifications inherited from overridden method in interface IndefiniteIterator:
       pure nullable

public behavior
assignable \nothing;
ensures_redundantly this.atEnd() == \old(this.atEnd());
signals (java.lang.Exception e) e instanceof java.util.NoSuchElementException&&this.atEnd();

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

Specifications:

     also

public normal_behavior
assignable objectState;
ensures !this.atEnd() ==> this.approve(this.get());

Specifications inherited from overridden method in interface IndefiniteIterator:

public normal_behavior
assignable objectState;

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

Specifications: (inherited)pure

Specifications inherited from overridden method in class Object:
       non_null

protected normal_behavior
requires this instanceof java.lang.Cloneable;
assignable \nothing;
ensures \result != null;
ensures \typeof(\result ) == \typeof(this);
ensures (* \result is a clone of this *);

     also

protected normal_behavior
requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures java.lang.reflect.Array.getLength(\result ) == java.lang.reflect.Array.getLength(this);
ensures ( \forall int i; 0 <= i&&i < java.lang.reflect.Array.getLength(this); ( \exists java.lang.Object result_i; result_i == java.lang.reflect.Array.get(\result ,i); (result_i == null&&java.lang.reflect.Array.get(this,i) == null)||(result_i != null&&result_i.equals(java.lang.reflect.Array.get(this,i)))));

     also

protected exceptional_behavior
requires !(this instanceof java.lang.Cloneable);
assignable \nothing;
signals_only java.lang.CloneNotSupportedException;

     also

protected normal_behavior
requires \elemtype(\typeof(this)) <: \type(java.lang.Object);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(int);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((int[])\result ).length == ((int[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((int[])this).length; ((int[])\result )[i] == ((int[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(byte);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((byte[])\result ).length == ((byte[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((byte[])this).length; ((byte[])\result )[i] == ((byte[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(char);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((char[])\result ).length == ((char[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((char[])this).length; ((char[])\result )[i] == ((char[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(long);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((long[])\result ).length == ((long[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((long[])this).length; ((long[])\result )[i] == ((long[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(short);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((short[])\result ).length == ((short[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((short[])this).length; ((short[])\result )[i] == ((short[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(boolean);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((boolean[])\result ).length == ((boolean[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((boolean[])this).length; ((boolean[])\result )[i] == ((boolean[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(float);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((float[])\result ).length == ((float[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((float[])this).length; (java.lang.Float.isNaN(((float[])\result )[i])&&java.lang.Float.isNaN(((float[])this)[i]))||((float[])\result )[i] == ((float[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(double);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((double[])\result ).length == ((double[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((double[])this).length; (java.lang.Double.isNaN(((double[])\result )[i])&&java.lang.Double.isNaN(((double[])this)[i]))||((double[])\result )[i] == ((double[])this)[i]);

Specifications inherited from overridden method in interface IndefiniteIterator:
       pure

     also

public normal_behavior
assignable \nothing;
ensures \fresh(\result )&&\result instanceof org.jmlspecs.jmlunit.strategies.IndefiniteIterator;
ensures \result != this;
ensures_redundantly \result != null;
ensures ((org.jmlspecs.jmlunit.strategies.IndefiniteIterator)\result ).atEnd() == this.atEnd();

toString

public String toString()

Overrides:

toString in class Object

Specifications inherited from overridden method in class Object:
       non_null

public normal_behavior
assignable objectState;
ensures \result != null&&\result .equals(this.theString);
ensures (* \result is a string representation of this object *);

     also

public code normal_behavior
assignable \nothing;
ensures \result != null&&(* \result is the instance's class name, followed by an @, followed by the instance's hashcode in hex *);

     also

public code model_program { ... }

    implies_that

assignable objectState;
ensures \result != null;