org.jmlspecs.models
Class JMLObjectToEqualsRelationEnumerator

java.lang.Object
  org.jmlspecs.models.JMLObjectToEqualsRelationEnumerator

All Implemented Interfaces:

Cloneable, Enumeration, JMLEnumeration, JMLType, JMLValueType, Serializable

public class JMLObjectToEqualsRelationEnumerator

extends Object

implements JMLEnumeration, JMLValueType

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

Version:

$Revision: 1.41 $

Author:

Gary T. Leavens

See Also:

JMLEnumeration, JMLValueType, JMLObjectToEqualsRelationImageEnumerator, JMLObjectToEqualsRelation, JMLObjectToEqualsMap, JMLEnumerationToIterator, JMLValueSet

Field Summary
protected  JMLEqualsSetEnumerator	imageEnum           An enumerator for the range elements that are related to the key that have not yet been returned.
protected  JMLObjectToEqualsRelationImageEnumerator	imagePairEnum           An enumerator for the image pairs in this relation.
protected  Object	key           The current key for pairs being enumerated.

 

Constructor Summary
(package private)	JMLObjectToEqualsRelationEnumerator(JMLObjectToEqualsRelation rel)           Initialize this with the given relation.
protected	JMLObjectToEqualsRelationEnumerator(JMLObjectToEqualsRelationImageEnumerator ipEnum, JMLEqualsSetEnumerator iEnum, Object k)

 

Method Summary
protected  JMLValueSet	abstractValue()           Return the set of uniterated pairs from this enumerator.
Object	clone()           Return a clone of this enumerator.
boolean	equals(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.
JMLObjectEqualsPair	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

 

Field Detail

imagePairEnum

protected JMLObjectToEqualsRelationImageEnumerator imagePairEnum

An enumerator for the image pairs in this relation.

key

protected Object key

The current key for pairs being enumerated.

imageEnum

protected JMLEqualsSetEnumerator imageEnum

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

JMLObjectToEqualsRelationEnumerator

JMLObjectToEqualsRelationEnumerator(JMLObjectToEqualsRelation rel)

Initialize this with the given relation.

JMLObjectToEqualsRelationEnumerator

protected JMLObjectToEqualsRelationEnumerator(JMLObjectToEqualsRelationImageEnumerator ipEnum,
                                              JMLEqualsSetEnumerator iEnum,
                                              Object k)

hasMoreElements

public boolean hasMoreElements()

Tells whether this enumerator has more uniterated elements.

Specified by:

hasMoreElements in interface JMLEnumeration

See Also:

nextElement(), nextPair()

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

nextPair

public JMLObjectEqualsPair nextPair()
                             throws JMLNoSuchElementException

Return the next pair in this, if there is one.

Throws:

JMLNoSuchElementException - when this is empty.

See Also:

hasMoreElements(), nextElement()

clone

public Object clone()

Return a clone of this enumerator.

Specified by:

clone in interface JMLEnumeration

Overrides:

clone in class Object

equals

public boolean equals(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

hashCode

public int hashCode()

Return a hash code for this enumerator.

Specified by:

hashCode in interface JMLType

Overrides:

hashCode in class Object

abstractValue

protected JMLValueSet abstractValue()

Return the set of uniterated pairs from this enumerator.