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.21 $

Author:

Gary T. Leavens, Brandon Shilling

See Also:

Integer, JMLLong, JMLShort, JMLByte, JMLChar, JMLType

Field Summary
private  int	intValue           The integer value of this object.
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(Integer inInteger)           Initialize this object to the given Integer's value.

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

 

Method Summary
Object	clone()           Return a clone of this object.
int	compareTo(Object op2)           Compare this to op2, returning a comparison code.
JMLInteger	dividedBy(JMLInteger i2)           Return a new object containing the quotient of this object's integer value divided by that of the given argument.
boolean	equals(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(JMLInteger i2)           Tell whether this object's integer value is strictly greater than that of the given argument.
boolean	greaterThanOrEqualTo(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(JMLInteger i2)           Tell whether this object's integer value is strictly less than that of the given argument.
boolean	lessThanOrEqualTo(JMLInteger i2)           Tell whether this object's integer value is less than or equal to that of the given argument.
JMLInteger	minus(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(JMLInteger i2)           Return a new object containing the sum of this object's integer value and that of the given argument.
JMLInteger	remainderBy(JMLInteger i2)           Return a new object containing the remainder of this object's integer value divided by that of the given argument.
JMLInteger	times(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

 

Field Detail

intValue

private int intValue

The integer value of this object.

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.

JMLInteger

public JMLInteger(int inInt)

Initialize this object to the given int.

JMLInteger

public JMLInteger(Integer inInteger)

Initialize this object to the given Integer's value.

Parameters:

inInteger - an object containing the value to use.

JMLInteger

public JMLInteger(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

clone

public Object clone()

Return a clone of this object.

Specified by:

clone in interface JMLType

Overrides:

clone in class Object

compareTo

public int compareTo(Object op2)
              throws 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.

equals

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

hashCode

public int hashCode()

Return a hash code for this object.

Specified by:

hashCode in interface JMLType

Overrides:

hashCode in class Object

intValue

public int intValue()

Return the integer value in this object.

getInteger

public Integer getInteger()

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

negated

public JMLInteger negated()

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

plus

public JMLInteger plus(JMLInteger i2)

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

minus

public JMLInteger minus(JMLInteger i2)

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

times

public JMLInteger times(JMLInteger i2)

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

dividedBy

public JMLInteger dividedBy(JMLInteger i2)

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

remainderBy

public JMLInteger remainderBy(JMLInteger i2)

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

greaterThan

public boolean greaterThan(JMLInteger i2)

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

lessThan

public boolean lessThan(JMLInteger i2)

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

greaterThanOrEqualTo

public boolean greaterThanOrEqualTo(JMLInteger i2)

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

lessThanOrEqualTo

public boolean lessThanOrEqualTo(JMLInteger i2)

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

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object