JML

org.jmlspecs.models
Class JMLByte

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

public class JMLByte
extends Object
implements JMLComparable

A reflection of Byte that implements JMLType.

Version:
$Revision: 1.27 $
Author:
Gary T. Leavens, Brandon Shilling
See Also:
Byte, JMLType, JMLChar, JMLInteger, JMLShort, JMLLong

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

byteValue

private byte byteValue
The byte value of this object.


ZERO

public static final JMLByte ZERO
The JMLByte that represents zero.


ONE

public static final JMLByte ONE
The JMLByte that represents one.

Constructor Detail

JMLByte

public JMLByte()
Initialize this object to 0.


JMLByte

public JMLByte(byte inByte)
Initialize this object to the given byte.


JMLByte

public JMLByte(Byte inByte)
Initialize this object to the given byte.

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

JMLByte

public JMLByte(String s)
        throws JMLTypeException
Initialize this object to the given byte.

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

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

byteValue

public byte byteValue()
Return the byte value in this object.


getByte

public Byte getByte()
Return an Byte object containing the byte value in this object.


negated

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


plus

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


minus

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


times

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


dividedBy

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


remainderBy

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


greaterThan

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


lessThan

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


greaterThanOrEqualTo

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


lessThanOrEqualTo

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