Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
JML
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jmlspecs.models
Class JMLValueToObjectRelationEnumerator

java.lang.Object
  extended byorg.jmlspecs.models.JMLValueToObjectRelationEnumerator
All Implemented Interfaces:
Cloneable, Enumeration, JMLEnumeration, JMLType, JMLValueType, Serializable
public class JMLValueToObjectRelationEnumerator
extends Object
implements JMLEnumeration, JMLValueType

Enumerator for pairs of keys of type JMLType to values of type Object that form the associations in a relation.

Version:
$Revision: 1.41 $
Author:
Gary T. Leavens
See Also:
JMLEnumeration, JMLValueType, JMLValueToObjectRelationImageEnumerator, JMLValueToObjectRelation, JMLValueToObjectMap, JMLEnumerationToIterator, JMLValueSet

Class Specifications
protected invariant this.moreElements <==> this.imageEnum.moreElements||this.imagePairEnum.moreElements;
protected invariant this.moreElements ==> this.key != null;
public invariant this.elementType == \type(org.jmlspecs.models.JMLValueObjectPair);
public invariant !this.returnsNull;
protected represents uniteratedPairs <- this.abstractValue();

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
 JMLValueSet uniteratedPairs
           
 
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  JMLObjectSetEnumerator imageEnum
          An enumerator for the range elements that are related to the key that have not yet been returned.
protected  JMLValueToObjectRelationImageEnumerator imagePairEnum
          An enumerator for the image pairs in this relation.
protected  JMLType key
          The current key for pairs being enumerated.
 
Constructor Summary
(package private) JMLValueToObjectRelationEnumerator(non_null JMLValueToObjectRelation rel)
          Initialize this with the given relation.
protected JMLValueToObjectRelationEnumerator(JMLValueToObjectRelationImageEnumerator ipEnum, JMLObjectSetEnumerator iEnum, JMLType k)
           
 
Model Method Summary
 
Model methods inherited from class java.lang.Object
hashValue
 
Method Summary
[spec_public] protected  JMLValueSet abstractValue()
          Return the set of uniterated pairs from this 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 image pair in this, if there is one.
 JMLValueObjectPair nextPair()
          Return the next pair in this, if there is one.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Model Field Detail

uniteratedPairs

public JMLValueSet uniteratedPairs
Specifications:
is in groups: objectState
datagroup contains: imagePairEnum key imageEnum
Field Detail

imagePairEnum

protected JMLValueToObjectRelationImageEnumerator imagePairEnum
An enumerator for the image pairs in this relation.

Specifications: non_null
is in groups: uniteratedPairs

key

protected JMLType key
The current key for pairs being enumerated.

Specifications:
is in groups: uniteratedPairs

imageEnum

protected JMLObjectSetEnumerator imageEnum
An enumerator for the range elements that are related to the key that have not yet been returned.

Specifications: non_null
is in groups: uniteratedPairs
Constructor Detail

JMLValueToObjectRelationEnumerator

JMLValueToObjectRelationEnumerator(non_null JMLValueToObjectRelation rel)
Initialize this with the given relation.

Specifications:
normal_behavior
requires rel != null;
assignable uniteratedPairs;
assignable moreElements, elementType, returnsNull, owner;
ensures this.uniteratedPairs.equals(rel.theRelation);
ensures this.owner == null;

JMLValueToObjectRelationEnumerator

protected JMLValueToObjectRelationEnumerator(JMLValueToObjectRelationImageEnumerator ipEnum,
                                             JMLObjectSetEnumerator iEnum,
                                             JMLType k)
Specifications:
requires ipEnum != null;
requires iEnum != null;
requires (ipEnum.moreElements||iEnum.moreElements) ==> k != null;
Method Detail

hasMoreElements

public boolean hasMoreElements()
Tells whether this enumerator has more uniterated elements.

Specified by:
hasMoreElements in interface JMLEnumeration
See Also:
nextElement(), nextPair()
Specifications: pure
     also
public normal_behavior
assignable \nothing;
ensures \result == !this.uniteratedPairs.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 image pair in this, if there is one.

Specified by:
nextElement in interface Enumeration
Throws:
JMLNoSuchElementException - when this is empty.
See Also:
hasMoreElements(), nextPair()
Specifications:
     also
public normal_behavior
requires !this.uniteratedPairs.isEmpty();
assignable uniteratedPairs;
ensures \old(this.uniteratedPairs).has((org.jmlspecs.models.JMLType)\result )&&this.uniteratedPairs.equals(\old(this.uniteratedPairs).remove((org.jmlspecs.models.JMLType)\result ));
     also
public exceptional_behavior
requires this.uniteratedPairs.isEmpty();
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;

nextPair

public JMLValueObjectPair nextPair()
                            throws JMLNoSuchElementException
Return the next pair in this, if there is one.

Throws:
JMLNoSuchElementException - when this is empty.
See Also:
hasMoreElements(), nextElement()
Specifications: non_null
public normal_behavior
requires !this.uniteratedPairs.isEmpty();
assignable uniteratedPairs, moreElements;
ensures \old(this.uniteratedPairs).has(\result )&&this.uniteratedPairs.equals(\old(this.uniteratedPairs).remove(\result ));
     also
public exceptional_behavior
requires this.uniteratedPairs.isEmpty();
assignable \nothing;
signals_only org.jmlspecs.models.JMLNoSuchElementException;
     also
assignable uniteratedPairs;
assignable moreElements;
ensures \old(this.moreElements);
signals_only org.jmlspecs.models.JMLNoSuchElementException;
signals (org.jmlspecs.models.JMLNoSuchElementException) \old(!this.moreElements);

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 JMLValueType:
       pure
     also
public normal_behavior
ensures \result instanceof org.jmlspecs.models.JMLValueType&&(* all externally-visible mutable objects contained directly in "this" must be cloned in \result. *);
    implies_that
ensures (* no direct aliases are created between this and \result *);
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: 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 JMLValueType:
       pure
     also
public normal_behavior
ensures \result ==> ob2 != null&&(* all externally-visible objects contained in ob2 test as ".equals()" to the corresponding object in this (and vice versa) *);
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: 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

abstractValue

protected JMLValueSet abstractValue()
Return the set of uniterated pairs from this enumerator.

Specifications: pure spec_public non_null
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
JML
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.