org.jmlspecs.models
Class JMLInteger

java.lang.Object
  org.jmlspecs.models.JMLInteger

All Implemented Interfaces:

Cloneable, Comparable, JMLComparable, JMLType, Serializable

public class JMLInteger

extends Object

implements JMLComparable

A reflection of Integer that implements JMLType.

Version:

$Revision: 1.24 $

Author:

Gary T. Leavens, Brandon Shilling

See Also:

Integer, JMLLong, JMLShort, JMLByte, JMLChar, JMLType

Class Specifications

public invariant this.owner == null; public constraint this.theInt == \old(this.theInt); private represents theInt <- this.intValue;

Specifications inherited from class Object

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

Specifications inherited from interface Comparable

instance public invariant ( \forall java.lang.Comparable x; x != null; x.compareTo(x) == 0); instance public invariant ( \forall java.lang.Comparable x, y; x != null&&y != null&&this.definedComparison(x,y)&&this.definedComparison(y,x); this.sgn(x.compareTo(y)) == -this.sgn(y.compareTo(x))); instance public invariant ( \forall int n; n == -1||n == 1; ( \forall java.lang.Comparable x, y, z; x != null&&y != null&&z != null&&this.definedComparison(x,y)&&this.definedComparison(y,z)&&this.definedComparison(x,z); this.sgn(x.compareTo(y)) == n&&this.sgn(y.compareTo(z)) == n ==> this.sgn(x.compareTo(z)) == n)); instance public invariant ( \forall int n; n == -1||n == 1; ( \forall java.lang.Comparable x, y, z; x != null&&y != null&&z != null&&this.definedComparison(x,y)&&this.definedComparison(y,z)&&this.definedComparison(x,z); (this.sgn(x.compareTo(y)) == 0&&this.sgn(y.compareTo(z)) == n||this.sgn(x.compareTo(y)) == n&&this.sgn(y.compareTo(z)) == 0) ==> this.sgn(x.compareTo(z)) == n)); instance public invariant ( \forall java.lang.Comparable x, y, z; x != null&&y != null&&z != null&&this.definedComparison(x,y)&&this.definedComparison(x,z)&&this.definedComparison(y,z); this.sgn(x.compareTo(y)) == 0 ==> this.sgn(x.compareTo(z)) == this.sgn(y.compareTo(z)));

Model Field Summary
int	theInt           The integer value of this object.

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Field Summary
private  int	intValue
static JMLInteger	ONE           The JMLInteger that represents one.
static JMLInteger	ZERO           The JMLInteger that represents zero.

 

Constructor Summary

JMLInteger()           Initialize this object to 0.

JMLInteger(int inInt)           Initialize this object to the given int.

JMLInteger(non_null Integer inInteger)           Initialize this object to the given Integer's value.

JMLInteger(non_null String s)           Initialize this object to the given integer.

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Model methods inherited from interface java.lang.Comparable

definedComparison, sgn

 

Method Summary
Object	clone()           Return a clone of this object.
int	compareTo(non_null Object op2)           Compare this to op2, returning a comparison code.
JMLInteger	dividedBy(non_null JMLInteger i2)           Return a new object containing the quotient of this object's integer value divided by that of the given argument.
boolean	equals(nullable Object op2)           Test whether this object's value is equal to the given argument.
Integer	getInteger()           Return an Integer object containing the integer value in this object.
boolean	greaterThan(non_null JMLInteger i2)           Tell whether this object's integer value is strictly greater than that of the given argument.
boolean	greaterThanOrEqualTo(non_null JMLInteger i2)           Tell whether this object's integer value is greater than or equal to that of the given argument.
int	hashCode()           Return a hash code for this object.
int	intValue()           Return the integer value in this object.
boolean	lessThan(non_null JMLInteger i2)           Tell whether this object's integer value is strictly less than that of the given argument.
boolean	lessThanOrEqualTo(non_null JMLInteger i2)           Tell whether this object's integer value is less than or equal to that of the given argument.
JMLInteger	minus(non_null JMLInteger i2)           Return a new object containing the difference between this object's integer value and that of the given argument.
JMLInteger	negated()           Return a new object containing the negation of this object's integer value.
JMLInteger	plus(non_null JMLInteger i2)           Return a new object containing the sum of this object's integer value and that of the given argument.
JMLInteger	remainderBy(non_null JMLInteger i2)           Return a new object containing the remainder of this object's integer value divided by that of the given argument.
JMLInteger	times(non_null JMLInteger i2)           Return a new object containing the product of this object's integer value and that of the given argument.
String	toString()           Return a string representation of this object.

 

Methods inherited from class java.lang.Object

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

 

Model Field Detail

theInt

public int theInt

The integer value of this object.

Specifications:
datagroup contains: intValue

intValue

private int intValue

Specifications:
is in groups: theInt

ZERO

public static final JMLInteger ZERO

The JMLInteger that represents zero.

ONE

public static final JMLInteger ONE

The JMLInteger that represents one.

JMLInteger

public JMLInteger()

Initialize this object to 0.

Specifications: (class)pure

public normal_behavior
assignable theInt, owner;
ensures this.theInt == 0;

JMLInteger

public JMLInteger(int inInt)

Initialize this object to the given int.

Specifications: (class)pure

public normal_behavior
assignable theInt, owner;
ensures this.theInt == inInt;

JMLInteger

public JMLInteger(non_null Integer inInteger)

Initialize this object to the given Integer's value.

Parameters:

inInteger - an object containing the value to use.

Specifications: (class)pure

public normal_behavior
requires inInteger != null;
assignable theInt, owner;
ensures this.theInt == inInteger.intValue();

JMLInteger

public JMLInteger(non_null String s)
           throws JMLTypeException

Initialize this object to the given integer.

Parameters:

s - a string that contains the decimal representation of the desired value.

Throws:

JMLTypeException

Specifications: (class)pure

public behavior
requires s != null&&(* s is a properly formatted int literal *);
assignable theInt, owner;
ensures this.theInt == (new java.lang.Integer(s)).intValue();

clone

public Object clone()

Return a clone of this object.

Specified by:

clone in interface JMLType

Overrides:

clone in class Object

Specifications: (class)pure

     also

public normal_behavior
ensures \result instanceof org.jmlspecs.models.JMLInteger&&((org.jmlspecs.models.JMLInteger)\result ).theInt == this.theInt;

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

compareTo

public int compareTo(non_null Object op2)
              throws NullPointerException,
                     ClassCastException

Compare this to op2, returning a comparison code.

Specified by:

compareTo in interface JMLComparable

Parameters:

op2 - the object this is compared to.

Throws:

ClassCastException - when o is not a JMLInteger.

NullPointerException

Specifications: (class)pure

     also

public normal_behavior
requires op2 instanceof org.jmlspecs.models.JMLInteger;
ensures (this.theInt < ((org.jmlspecs.models.JMLInteger)op2).theInt ==> \result == -1)&&(this.theInt == ((org.jmlspecs.models.JMLInteger)op2).theInt ==> \result == 0)&&(this.theInt > ((org.jmlspecs.models.JMLInteger)op2).theInt ==> \result == 1);

     also

public exceptional_behavior
requires op2 != null&&!(op2 instanceof org.jmlspecs.models.JMLInteger);
signals_only java.lang.ClassCastException;

Specifications inherited from overridden method compareTo(Object o) in interface JMLComparable:
       (class)pure

     also

public behavior
requires o != null;
ensures (* o is an instance of a comparable class *);
ensures (* if this is equal to o, then \result is 0 *)&&(* if this is less than o, then \result is negative *)&&(* if this is greater than o, then \result is positive *);
signals_only java.lang.ClassCastException;
signals (java.lang.ClassCastException) (* o is not an instance of a comparable class *);

Specifications inherited from overridden method compareTo(Object o) in interface Comparable:
       pure

public behavior
requires o != null;
ensures (* \result is negative if this is "less than" o *);
ensures (* \result is 0 if this is "equal to" o *);
ensures (* \result is positive if this is "greater than" o *);
signals_only java.lang.ClassCastException;
signals (java.lang.ClassCastException) (* the class of o prohibits it from being compared to this *);

     also

public behavior
requires o != null&&o instanceof java.lang.Comparable;
ensures this.definedComparison((java.lang.Comparable)o,this);
ensures o == this ==> \result == 0;
ensures this.sgn(\result ) == -this.sgn(((java.lang.Comparable)o).compareTo(this));
signals (java.lang.ClassCastException) !this.definedComparison((java.lang.Comparable)o,this);

equals

public boolean equals(nullable Object op2)

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

Specified by:

equals in interface JMLType

Overrides:

equals in class Object

Specifications: (class)pure

     also

public normal_behavior
ensures \result <==> op2 != null&&op2 instanceof org.jmlspecs.models.JMLInteger&&this.theInt == ((org.jmlspecs.models.JMLInteger)op2).theInt;

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 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 object.

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

intValue

public int intValue()

Return the integer value in this object.

Specifications: (class)pure

public normal_behavior
ensures \result == this.theInt;

getInteger

public Integer getInteger()

Return an Integer object containing the integer value in this object.

Specifications: non_null (class)pure

public normal_behavior
ensures \result != null&&\result .equals(new java.lang.Integer(this.theInt));

negated

public JMLInteger negated()

Return a new object containing the negation of this object's integer value.

Specifications: non_null (class)pure

public normal_behavior
ensures \result != null&&\result .theInt == -this.theInt;

plus

public JMLInteger plus(non_null JMLInteger i2)

Return a new object containing the sum of this object's integer value and that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null;
ensures \result != null&&\result .theInt == this.theInt+i2.theInt;

minus

public JMLInteger minus(non_null JMLInteger i2)

Return a new object containing the difference between this object's integer value and that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null;
ensures \result != null&&\result .theInt == this.theInt-i2.theInt;

times

public JMLInteger times(non_null JMLInteger i2)

Return a new object containing the product of this object's integer value and that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null;
ensures \result != null&&\result .theInt == this.theInt*i2.theInt;

dividedBy

public JMLInteger dividedBy(non_null JMLInteger i2)

Return a new object containing the quotient of this object's integer value divided by that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null&&!i2.equals(new org.jmlspecs.models.JMLInteger(0));
ensures \result != null&&\result .theInt == this.theInt/i2.theInt;

remainderBy

public JMLInteger remainderBy(non_null JMLInteger i2)

Return a new object containing the remainder of this object's integer value divided by that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null&&!i2.equals(new org.jmlspecs.models.JMLInteger(0));
ensures \result != null&&\result .theInt == this.theInt%i2.theInt;

greaterThan

public boolean greaterThan(non_null JMLInteger i2)

Tell whether this object's integer value is strictly greater than that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theInt > i2.theInt;

lessThan

public boolean lessThan(non_null JMLInteger i2)

Tell whether this object's integer value is strictly less than that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theInt < i2.theInt;

greaterThanOrEqualTo

public boolean greaterThanOrEqualTo(non_null JMLInteger i2)

Tell whether this object's integer value is greater than or equal to that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theInt >= i2.theInt;

lessThanOrEqualTo

public boolean lessThanOrEqualTo(non_null JMLInteger i2)

Tell whether this object's integer value is less than or equal to that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theInt <= i2.theInt;

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object

Specifications: (class)pure

     also

public normal_behavior
ensures \result != null&&\result .equals(this.getInteger().toString());

Specifications inherited from overridden method in class Object:
       non_null

public normal_behavior
assignable objectState;
ensures \result != null&&\result .equals(this.theString);
ensures (* \result is a string representation of this object *);

     also

public code normal_behavior
assignable \nothing;
ensures \result != null&&(* \result is the instance's class name, followed by an @, followed by the instance's hashcode in hex *);

     also

public code model_program { ... }

    implies_that

assignable objectState;
ensures \result != null;