org.jmlspecs.models
Class JMLObjectSequenceEnumerator

java.lang.Object
  org.jmlspecs.models.JMLObjectSequenceEnumerator

All Implemented Interfaces:

Cloneable, Enumeration, JMLEnumeration, JMLObjectType, JMLType, Serializable

public class JMLObjectSequenceEnumerator

extends Object

implements JMLEnumeration, JMLObjectType

An enumerator for sequences of objects.

Version:

$Revision: 1.32 $

Author:

Gary T. Leavens, with help from Albert Baker, Clyde Ruby, and others.

See Also:

JMLEnumeration, JMLType, JMLObjectSequence, JMLValueSequence, JMLEnumerationToIterator

Class Specifications

public invariant this.uniteratedElems != null; public invariant this.moreElements <==> this.remaining != 0; public invariant this.remaining >= 0; protected invariant this.currentNode == null <==> this.remaining == 0; public invariant this.elementType <: \type(java.lang.Object); public invariant !this.uniteratedElems.isEmpty() ==> this.uniteratedElems.elementType <: this.elementType; public invariant !this.returnsNull ==> this.uniteratedElems.isEmpty()||!this.uniteratedElems.containsNull; public constraint this.returnsNull == \old(this.returnsNull); protected represents uniteratedElems <- new org.jmlspecs.models.JMLObjectSequence(this.currentNode, this.remaining);

Specifications inherited from class Object

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

Specifications inherited from interface JMLEnumeration

instance public represents moreElements <- this.hasMoreElements();

Model Field Summary
JMLObjectSequence	uniteratedElems           The elements that have not yet been returned by nextElement.

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Model fields inherited from interface java.util.Enumeration

moreElements

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Ghost fields inherited from interface java.util.Enumeration

elementType, returnsNull

 

Field Summary
protected  JMLListObjectNode	currentNode           The list representing the elements yet to be returned.
[spec_public] protected  int	remaining           The number of elements remaining to return.

 

Constructor Summary
(package private)	JMLObjectSequenceEnumerator(non_null JMLObjectSequence s)           Initialize this with the given sequence.

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
Object	clone()           Return a clone of this enumerator.
boolean	equals(nullable Object oth)           Return true just when this enumerator has the same state as the given argument..
int	hashCode()           Return a hash code for this enumerator.
boolean	hasMoreElements()           Tells whether this enumerator has more uniterated elements.
Object	nextElement()           Return the next element in the sequence, counting up, if there is one.

 

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Model Field Detail

uniteratedElems

public JMLObjectSequence uniteratedElems

The elements that have not yet been returned by nextElement.

Specifications:
is in groups: objectState
datagroup contains: currentNode remaining

currentNode

protected JMLListObjectNode currentNode

The list representing the elements yet to be returned.

Specifications:
is in groups: uniteratedElems

remaining

protected int remaining

The number of elements remaining to return.

Specifications: spec_public
is in groups: uniteratedElems

JMLObjectSequenceEnumerator

JMLObjectSequenceEnumerator(non_null JMLObjectSequence s)

Initialize this with the given sequence.

Specifications:

normal_behavior
requires s != null;
assignable uniteratedElems;
assignable moreElements, elementType, returnsNull, owner;
ensures this.uniteratedElems.equals(s);
ensures this.owner == null;
ensures this.elementType == s.elementType;
ensures this.returnsNull == s.containsNull;

hasMoreElements

public boolean hasMoreElements()

Tells whether this enumerator has more uniterated elements.

Specified by:

hasMoreElements in interface JMLEnumeration

Specifications: pure

     also

public normal_behavior
ensures \result == !this.uniteratedElems.isEmpty();
ensures \result <==> this.remaining > 0;

Specifications inherited from overridden method in interface JMLEnumeration:
       pure

     also

assignable \nothing;

Specifications inherited from overridden method in interface Enumeration:

public normal_behavior
assignable objectState;
ensures \result <==> this.moreElements;

nextElement

public Object nextElement()
                   throws JMLNoSuchElementException

Return the next element in the sequence, counting up, if there is one.

Specified by:

nextElement in interface Enumeration

Throws:

JMLNoSuchElementException - when this is empty.

Specifications:

     also

public normal_behavior
requires this.hasMoreElements();
assignable uniteratedElems, moreElements;
ensures \old(this.uniteratedElems).itemAt(0) == \result &&this.uniteratedElems.equals(\old(this.uniteratedElems).trailer());

     also

public exceptional_behavior
requires !this.hasMoreElements();
assignable \nothing;
signals (org.jmlspecs.models.JMLNoSuchElementException) true;

     also

protected normal_behavior
requires this.remaining > 0;
assignable uniteratedElems, moreElements;
assignable_redundantly currentNode, remaining;
ensures this.currentNode == \old(this.currentNode.next)&&this.remaining == \old(this.remaining-1);

Specifications inherited from overridden method in interface Enumeration:
       nullable

public normal_behavior
requires this.moreElements;
assignable objectState;
assignable moreElements;
ensures (\result == null)||\typeof(\result ) <: this.elementType;
ensures !this.returnsNull ==> (\result != null);

     also

public exceptional_behavior
requires !this.moreElements;
assignable \nothing;
signals_only java.util.NoSuchElementException;

clone

public Object clone()

Return a clone of this enumerator.

Specified by:

clone in interface JMLEnumeration

Overrides:

clone in class Object

Specifications: non_null (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 JMLEnumeration:
      --- None ---

Specifications inherited from overridden method in interface JMLObjectType:
       pure

     also

public normal_behavior
ensures \result instanceof org.jmlspecs.models.JMLObjectType;

Specifications inherited from overridden method in interface JMLType:
       pure

     also

public normal_behavior
ensures \result != null;
ensures \result instanceof org.jmlspecs.models.JMLType;
ensures ((org.jmlspecs.models.JMLType)\result ).equals(this);

    implies_that

ensures \result != null&&\typeof(\result ) <: \type(org.jmlspecs.models.JMLType);

equals

public boolean equals(nullable Object oth)

Return true just when this enumerator has the same state as the given argument..

Specified by:

equals in interface JMLType

Overrides:

equals in class Object

Specifications: (inherited)pure

Specifications inherited from overridden method equals(Object obj) in class Object:
       pure

public normal_behavior
requires obj != null;
ensures (* \result is true when obj is "equal to" this object *);

     also

public normal_behavior
requires this == obj;
ensures \result ;

     also

public code normal_behavior
requires obj != null;
ensures \result <==> this == obj;

     also

diverges false;
ensures obj == null ==> !\result ;

Specifications inherited from overridden method equals(Object ob2) in interface JMLObjectType:
       pure

     also

public normal_behavior
ensures \result ==> ob2 != null&&(* ob2 and this contain the same object references *);

Specifications inherited from overridden method equals(Object ob2) in interface JMLType:
       pure

     also

public normal_behavior
ensures \result ==> ob2 != null&&(* ob2 is not distinguishable from this, except by using mutation or == *);

    implies_that

public normal_behavior

{|

requires ob2 != null&&ob2 instanceof org.jmlspecs.models.JMLType;
ensures ((org.jmlspecs.models.JMLType)ob2).equals(this) == \result ;

also

requires ob2 == this;
ensures \result <==> true;

|}

hashCode

public int hashCode()

Return a hash code for this enumerator.

Specified by:

hashCode in interface JMLType

Overrides:

hashCode in class Object

Specifications: (inherited)pure

Specifications inherited from overridden method in class Object:

public behavior
assignable objectState;
ensures (* \result is a hash code for this object *);

     also

public code normal_behavior
assignable \nothing;

Specifications inherited from overridden method in interface JMLType:
       pure