org.jmlspecs.models
Class JMLObjectEqualsPair

java.lang.Object
  org.jmlspecs.models.JMLObjectEqualsPair

All Implemented Interfaces:

Cloneable, JMLType, Serializable

public class JMLObjectEqualsPair

extends Object

implements JMLType

Pairs of Object and Object, used in the types JMLObjectToEqualsRelation and JMLObjectToEqualsMap.

In a pair the first element is called the "key" and the second the "value". Both the key and the value in a pair must be non-null.

Version:

$Revision: 1.30 $

Author:

Gary T. Leavens, Clyde Ruby

See Also:

JMLObjectToEqualsRelation, JMLObjectToEqualsMap

Field Summary
Object	key           The key of this pair.
Object	value           The value of this pair.

 

Constructor Summary

JMLObjectEqualsPair(Object dv, Object rv)           Initialize the key and value of this pair.

 

Method Summary
Object	clone()           Return a clone of this object.
boolean	equals(Object obj)           Test whether this object's value is equal to the given argument.
int	hashCode()           Return a hash code for this object.
boolean	keyEquals(Object dv)           Tell whether this object's key is equal to the given key.
String	toString()           Return a string representation of this object.
boolean	valueEquals(Object rv)           Tell whether this object's key is equal to the given key.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

key

public final Object key

The key of this pair.

value

public final Object value

The value of this pair.

JMLObjectEqualsPair

public JMLObjectEqualsPair(Object dv,
                           Object rv)
                    throws NullPointerException

Initialize the key and value of this pair.

Throws:

NullPointerException

clone

public Object clone()

Description copied from interface: JMLType

Return a clone of this object.

Specified by:

clone in interface JMLType

Overrides:

clone in class Object

keyEquals

public boolean keyEquals(Object dv)

Tell whether this object's key is equal to the given key.

See Also:

equals(java.lang.Object)

valueEquals

public boolean valueEquals(Object rv)

Tell whether this object's key is equal to the given key.

See Also:

equals(java.lang.Object)

equals

public boolean equals(Object obj)

Test whether this object's value is equal to the given argument.

Specified by:

equals in interface JMLType

Overrides:

equals in class Object

See Also:

keyEquals(java.lang.Object)

hashCode

public int hashCode()

Return a hash code for this object.

Specified by:

hashCode in interface JMLType

Overrides:

hashCode in class Object

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object