java.lang
Class Byte

java.lang.Object
  |
  +--java.lang.Number
        |
        +--java.lang.Byte

All Implemented Interfaces:

Comparable

public final class Byte

extends Number

implements Comparable

The Byte class is the standard wrapper for byte values.

Since:

JDK1.1

Version:

1.20, 02/02/00

Author:

Nakul Saraiya

See Also:

Number

Field Summary

static byte	MAX_VALUE The maximum value a Byte can have.
static byte	MIN_VALUE The minimum value a Byte can have.

Constructor Summary

Byte(byte value)
Constructs a Byte object initialized to the specified byte value.

Byte(String s)
Constructs a Byte object initialized to the value specified by the String parameter.

Method Summary

byte	byteValue() Returns the value of this Byte as a byte.
int	compareTo(Byte anotherByte) Compares two Bytes numerically.
int	compareTo(Object o) Compares this Byte to another Object.
static Byte	decode(String nm) Decodes a String into a Byte.
double	doubleValue() Returns the value of this Byte as a double.
boolean	equals(Object obj) Compares this object to the specified object.
float	floatValue() Returns the value of this Byte as a float.
int	hashCode() Returns a hashcode for this Byte.
int	intValue() Returns the value of this Byte as an int.
long	longValue() Returns the value of this Byte as a long.
static byte	parseByte(String s) Assuming the specified String represents a byte, returns that byte's value.
static byte	parseByte(String s, int radix) Assuming the specified String represents a byte, returns that byte's value.
short	shortValue() Returns the value of this Byte as a short.
String	toString() Returns a String object representing this Byte's value.
static String	toString(byte b) Returns a new String object representing the specified Byte.
static Byte	valueOf(String s) Assuming the specified String represents a byte, returns a new Byte object initialized to that value.
static Byte	valueOf(String s, int radix) Assuming the specified String represents a byte, returns a new Byte object initialized to that value.

Methods inherited from class java.lang.Object

clone, finalize, getClass

Field Detail

MAX_VALUE

public static final byte MAX_VALUE

The maximum value a Byte can have.

See Also:

Constant Field Values

MIN_VALUE

public static final byte MIN_VALUE

The minimum value a Byte can have.

See Also:

Constant Field Values

Constructor Detail

Byte

public Byte(byte value)

Constructs a Byte object initialized to the specified byte value.

Parameters:

value - the initial value of the Byte

Byte

public Byte(String s)
     throws NumberFormatException

Constructs a Byte object initialized to the value specified by the String parameter. The radix is assumed to be 10.

Parameters:

s - the String to be converted to a Byte

Throws:

NumberFormatException - If the String does not contain a parsable byte.

Method Detail

byteValue

public byte byteValue()

Returns the value of this Byte as a byte.

Overrides:

byteValue in class Number

Returns:

the numeric value represented by this object after conversion to type byte.

compareTo

public int compareTo(Byte anotherByte)

Compares two Bytes numerically.

Parameters:

anotherByte - the Byte to be compared.

Returns:

the value 0 if the argument Byte is equal to this Byte; a value less than 0 if this Byte is numerically less than the Byte argument; and a value greater than 0 if this Byte is numerically greater than the Byte argument (signed comparison).

Since:

1.2

compareTo

public int compareTo(Object o)

Compares this Byte to another Object. If the Object is a Byte, this function behaves like compareTo(Byte). Otherwise, it throws a ClassCastException (as Bytes are comparable only to other Bytes).

Specified by:

compareTo in interface Comparable

Parameters:

o - the Object to be compared.

Returns:

the value 0 if the argument is a Byte numerically equal to this Byte; a value less than 0 if the argument is a Byte numerically greater than this Byte; and a value greater than 0 if the argument is a Byte numerically less than this Byte.

Throws:

ClassCastException - if the argument is not a Byte.

Since:

1.2

See Also:

Comparable

decode

public static Byte decode(String nm)
                   throws NumberFormatException

Decodes a String into a Byte. Accepts decimal, hexadecimal, and octal numbers, in the following formats:

     [-]       decimal constant
     [-] 0x    hex constant
     [-] #     hex constant
     [-] 0     octal constant
 

The constant following an (optional) negative sign and/or "radix specifier" is parsed as by the Byte.parseByte method with the specified radix (10, 8 or 16). This constant must be positive or a NumberFormatException will result. The result is made negative if first character of the specified String is the negative sign. No whitespace characters are permitted in the String.

Parameters:

nm - the String to decode.

Returns:

the Byte represented by the specified string.

Throws:

NumberFormatException - if the String does not contain a parsable byte.

See Also:

parseByte(String, int)

doubleValue

public double doubleValue()

Returns the value of this Byte as a double.

Specified by:

doubleValue in class Number

Returns:

the numeric value represented by this object after conversion to type double.

equals

public boolean equals(Object obj)

Compares this object to the specified object.

Overrides:

equals in class Object

Parameters:

obj - the object to compare with

Returns:

true if the objects are the same; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

floatValue

public float floatValue()

Returns the value of this Byte as a float.

Specified by:

floatValue in class Number

Returns:

the numeric value represented by this object after conversion to type float.

hashCode

public int hashCode()

Returns a hashcode for this Byte.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

intValue

public int intValue()

Returns the value of this Byte as an int.

Specified by:

intValue in class Number

Returns:

the numeric value represented by this object after conversion to type int.

longValue

public long longValue()

Returns the value of this Byte as a long.

Specified by:

longValue in class Number

Returns:

the numeric value represented by this object after conversion to type long.

parseByte

public static byte parseByte(String s)
                      throws NumberFormatException

Assuming the specified String represents a byte, returns that byte's value. Throws an exception if the String cannot be parsed as a byte. The radix is assumed to be 10.

Parameters:

s - the String containing the byte

Returns:

the parsed value of the byte

Throws:

NumberFormatException - If the string does not contain a parsable byte.

parseByte

public static byte parseByte(String s,
                             int radix)
                      throws NumberFormatException

Assuming the specified String represents a byte, returns that byte's value. Throws an exception if the String cannot be parsed as a byte.

Parameters:

s - the String containing the byte

radix - the radix to be used

Returns:

the parsed value of the byte

Throws:

NumberFormatException - If the String does not contain a parsable byte.

shortValue

public short shortValue()

Returns the value of this Byte as a short.

Overrides:

shortValue in class Number

Returns:

the numeric value represented by this object after conversion to type short.

toString

public String toString()

Returns a String object representing this Byte's value.

Overrides:

toString in class Object

Returns:

a string representation of the object.

toString

public static String toString(byte b)

Returns a new String object representing the specified Byte. The radix is assumed to be 10.

Parameters:

b - the byte to be converted

Returns:

the string representation of the specified byte

valueOf

public static Byte valueOf(String s)
                    throws NumberFormatException

Assuming the specified String represents a byte, returns a new Byte object initialized to that value. Throws an exception if the String cannot be parsed as a byte. The radix is assumed to be 10.

Parameters:

s - the String containing the integer

Returns:

the Byte instance representing the parsed byte value

Throws:

NumberFormatException - If the String does not contain a parsable byte.

valueOf

public static Byte valueOf(String s,
                           int radix)
                    throws NumberFormatException

Assuming the specified String represents a byte, returns a new Byte object initialized to that value. Throws an exception if the String cannot be parsed as a byte.

Parameters:

s - the String containing the integer

radix - the radix to be used

Returns:

the Byte instance representing the parsed byte value

Throws:

NumberFormatException - If the String does not contain a parsable byte.