JML

org.jmlspecs.models
Class JMLLong

java.lang.Object
  extended byorg.jmlspecs.models.JMLLong
All Implemented Interfaces:
Cloneable, Comparable, JMLComparable, JMLType, Serializable

public class JMLLong
extends Object
implements JMLComparable

A reflection of Long that implements JMLType.

Version:
$Revision: 1.24 $
Author:
Gary T. Leavens, Brandon Shilling
See Also:
Long, JMLInteger, JMLShort, JMLByte, JMLChar, JMLType

Field Summary
private  long longValue
          The long value of this object.
static JMLLong ONE
          The JMLLong that represents one.
static JMLLong ZERO
          The JMLLong that represents zero.
 
Constructor Summary
JMLLong()
          Initialize this object to 0.
JMLLong(int inInt)
          Initialize this object to the given int.
JMLLong(Long inLong)
          Initialize this object to the given long.
JMLLong(String s)
          Initialize this object to the given long.
JMLLong(long inLong)
          Initialize this object to the given long.
 
Method Summary
 Object clone()
          Return a clone of this object.
 int compareTo(Object op2)
          Compare this to op2, returning a comparison code.
 JMLLong dividedBy(JMLLong i2)
          Return a new object containing the quotient of this object's long value divided by that of the given argument.
 boolean equals(Object op2)
          Test whether this object's value is equal to the given argument.
 Long getLong()
          Return an Long object containing the long value in this object.
 boolean greaterThan(JMLLong i2)
          Tell whether this object's long value is strictly greater than that of the given argument.
 boolean greaterThanOrEqualTo(JMLLong i2)
          Tell whether this object's long value is greater than or equal to that of the given argument.
 int hashCode()
          Return a hash code for this object.
 boolean lessThan(JMLLong i2)
          Tell whether this object's long value is strictly less than that of the given argument.
 boolean lessThanOrEqualTo(JMLLong i2)
          Tell whether this object's long value is less than or equal to that of the given argument.
 long longValue()
          Return the long value in this object.
 JMLLong minus(JMLLong i2)
          Return a new object containing the difference between this object's long value and that of the given argument.
 JMLLong negated()
          Return a new object containing the negation of this object's long value.
 JMLLong plus(JMLLong i2)
          Return a new object containing the sum of this object's long value and that of the given argument.
 JMLLong remainderBy(JMLLong i2)
          Return a new object containing the remainder of this object's long value divided by that of the given argument.
 JMLLong times(JMLLong i2)
          Return a new object containing the product of this object's long 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

longValue

private long longValue
The long value of this object.


ZERO

public static final JMLLong ZERO
The JMLLong that represents zero.


ONE

public static final JMLLong ONE
The JMLLong that represents one.

Constructor Detail

JMLLong

public JMLLong()
Initialize this object to 0.


JMLLong

public JMLLong(long inLong)
Initialize this object to the given long.


JMLLong

public JMLLong(int inInt)
Initialize this object to the given int.


JMLLong

public JMLLong(Long inLong)
Initialize this object to the given long.

Parameters:
inLong - an object containing the value to use.

JMLLong

public JMLLong(String s)
        throws JMLTypeException
Initialize this object to the given long.

Parameters:
s - a string that contains the decimal representation of the desired value.
Throws:
JMLTypeException
Method Detail

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

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

longValue

public long longValue()
Return the long value in this object.


getLong

public Long getLong()
Return an Long object containing the long value in this object.


negated

public JMLLong negated()
Return a new object containing the negation of this object's long value.


plus

public JMLLong plus(JMLLong i2)
Return a new object containing the sum of this object's long value and that of the given argument.


minus

public JMLLong minus(JMLLong i2)
Return a new object containing the difference between this object's long value and that of the given argument.


times

public JMLLong times(JMLLong i2)
Return a new object containing the product of this object's long value and that of the given argument.


dividedBy

public JMLLong dividedBy(JMLLong i2)
Return a new object containing the quotient of this object's long value divided by that of the given argument.


remainderBy

public JMLLong remainderBy(JMLLong i2)
Return a new object containing the remainder of this object's long value divided by that of the given argument.


greaterThan

public boolean greaterThan(JMLLong i2)
Tell whether this object's long value is strictly greater than that of the given argument.


lessThan

public boolean lessThan(JMLLong i2)
Tell whether this object's long value is strictly less than that of the given argument.


greaterThanOrEqualTo

public boolean greaterThanOrEqualTo(JMLLong i2)
Tell whether this object's long value is greater than or equal to that of the given argument.


lessThanOrEqualTo

public boolean lessThanOrEqualTo(JMLLong i2)
Tell whether this object's long 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

JML

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.