org.jmlspecs.models
Interface JMLType

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

Directory, DirObserverKeeper, Entry, JMLCollection, JMLComparable, JMLEnumeration, JMLInfiniteInteger, JMLIterator, JMLObjectType, JMLValueType, Money, MoneyComparable, MoneyOps, NodeType, RODirectory

All Known Implementing Classes:

ArcType, EntryImplementation, JMLByte, JMLChar, JMLDouble, JMLEnumerationToIterator, JMLEqualsBag, JMLEqualsBagEntry, JMLEqualsBagEnumerator, JMLEqualsEqualsPair, JMLEqualsObjectPair, JMLEqualsSequence, JMLEqualsSequenceEnumerator, JMLEqualsSet, JMLEqualsSetEnumerator, JMLEqualsToEqualsRelation, JMLEqualsToEqualsRelationEnumerator, JMLEqualsToEqualsRelationImageEnumerator, JMLEqualsToObjectRelation, JMLEqualsToObjectRelationEnumerator, JMLEqualsToObjectRelationImageEnumerator, JMLEqualsToValueRelation, JMLEqualsToValueRelationEnumerator, JMLEqualsToValueRelationImageEnumerator, JMLEqualsValuePair, JMLFloat, JMLInfiniteIntegerClass, JMLInteger, JMLListEqualsNode, JMLListObjectNode, JMLListValueNode, JMLLong, JMLObjectBag, JMLObjectBagEntry, JMLObjectBagEnumerator, JMLObjectEqualsPair, JMLObjectObjectPair, JMLObjectSequence, JMLObjectSequenceEnumerator, JMLObjectSet, JMLObjectSetEnumerator, JMLObjectToEqualsRelation, JMLObjectToEqualsRelationEnumerator, JMLObjectToEqualsRelationImageEnumerator, JMLObjectToObjectRelation, JMLObjectToObjectRelationEnumerator, JMLObjectToObjectRelationImageEnumerator, JMLObjectToValueRelation, JMLObjectToValueRelationEnumerator, JMLObjectToValueRelationImageEnumerator, JMLObjectValuePair, JMLShort, JMLString, JMLValueBag, JMLValueBagEntry, JMLValueBagEnumerator, JMLValueBagSpecs, JMLValueEqualsPair, JMLValueObjectPair, JMLValueSequence, JMLValueSequenceEnumerator, JMLValueSequenceSpecs, JMLValueSet, JMLValueSetEnumerator, JMLValueSetSpecs, JMLValueToEqualsRelation, JMLValueToEqualsRelationEnumerator, JMLValueToEqualsRelationImageEnumerator, JMLValueToObjectRelation, JMLValueToObjectRelationEnumerator, JMLValueToObjectRelationImageEnumerator, JMLValueToValueRelation, JMLValueToValueRelationEnumerator, JMLValueToValueRelationImageEnumerator, JMLValueValuePair, MoneyAC, MoneyComparableAC, NaturalNumber, QueueEntry, StringOfObject, USMoney, ValueNode

public interface JMLType

extends Cloneable, Serializable

Objects with a clone and equals method. JMLObjectType and JMLValueType are refinements for object and value containers (respectively).

Version:

$Revision: 1.20 $

Author:

Gary T. Leavens and Albert L. Baker.

See Also:

JMLObjectType, JMLValueType

Class Specifications

Specifications inherited from class Object

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

Method Summary
Object	clone()           Return a clone of this object.
boolean	equals(nullable Object ob2)           Test whether this object's value is equal to the given argument.
int	hashCode()           Return a hash code for this object.

 

Method Detail

clone

public Object clone()

Return a clone of this object.

Overrides:

clone in class Object

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

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

equals

public boolean equals(nullable Object ob2)

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

Overrides:

equals in class Object

Specifications: 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;

|}

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 ;

hashCode

public int hashCode()

Return a hash code for this object.

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;