org.jmlspecs.models
Class JMLEqualsBagEnumerator

java.lang.Object
  org.jmlspecs.models.JMLEqualsBagEnumerator

All Implemented Interfaces:

Cloneable, Enumeration, JMLEnumeration, JMLObjectType, JMLType, Serializable

public class JMLEqualsBagEnumerator

extends Object

implements JMLEnumeration, JMLObjectType

Enumerators for bags (i.e., multisets) of objects.

Version:

$Revision: 1.42 $

Author:

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

See Also:

JMLEnumeration, JMLType, JMLEqualsBag, JMLEnumerationToIterator

Class Specifications

protected invariant this.currentCount >= 0; protected invariant this.currentCount > 0 ==> (* currEntry is holds an element, which may be null *); protected invariant !this.currentBag.isEmpty() ==> this.currentBag.has(this.currEntry)&&this.currentCount <= this.currentBag.count(this.currEntry); protected invariant this.currentCount > 0 ==> this.moreElements; protected invariant this.moreElements <==> (this.currentCount > 0||!this.currentBag.isEmpty()); 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 <- this.currentBag.removeAll(this.currEntry).insert(this.currEntry,this.currentCount);

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
JMLEqualsBag	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  JMLEqualsBag	currentBag           The bag underlying this enumerator.
protected  int	currentCount           The remaining count of repetitions that the current entry should be returned.
protected  Object	currEntry           The current entry.

 

Constructor Summary
(package private)	JMLEqualsBagEnumerator(non_null JMLEqualsBag b)           Initialize this with the given bag.

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
protected  JMLEqualsBag	abstractValue()           Return the abstract value of this bag enumerator.
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 this, if there is one.

 

Methods inherited from class java.lang.Object

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

 

Model Field Detail

uniteratedElems

public JMLEqualsBag uniteratedElems

The elements that have not yet been returned by nextElement.

Specifications:
is in groups: objectState
datagroup contains: currentBag currentCount currEntry

currentBag

protected JMLEqualsBag currentBag

The bag underlying this enumerator.

Specifications: non_null
is in groups: uniteratedElems

currentCount

protected int currentCount

The remaining count of repetitions that the current entry should be returned.

Specifications:
is in groups: uniteratedElems

currEntry

protected Object currEntry

The current entry.

Specifications:
is in groups: uniteratedElems

JMLEqualsBagEnumerator

JMLEqualsBagEnumerator(non_null JMLEqualsBag b)

Initialize this with the given bag.

Specifications:

normal_behavior
requires b != null;
assignable uniteratedElems;
assignable moreElements, elementType, returnsNull, owner;
ensures this.uniteratedElems.equals(b);
ensures this.owner == null;
ensures this.elementType == b.elementType;
ensures this.returnsNull == b.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_redundantly \result == this.moreElements;
ensures_redundantly \result <==> !this.uniteratedElems.isEmpty();
ensures_redundantly \result <=!=> this.uniteratedElems.isEmpty();
ensures_redundantly \result != this.uniteratedElems.isEmpty();

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 this, 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).has(\result )&&this.uniteratedElems.equals(\old(this.uniteratedElems).remove(\result ));

     also

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

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);

abstractValue

protected JMLEqualsBag abstractValue()

Return the abstract value of this bag enumerator.

Specifications: pure non_null

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