java.lang
Class Byte

java.lang.Object
  java.lang.Number
      java.lang.Byte

All Implemented Interfaces:

Serializable, Comparable<Byte>

public final class Byte
extends Number
implements Comparable<Byte>

Byte is the wrapper for the primitive type byte.

Since:

1.1

See Also:

Serialized Form

Field Summary

static byte	MAX_VALUE Constant for the maximum byte value, 27-1.
static byte	MIN_VALUE Constant for the minimum byte value, -27.
static int	SIZE Constant for the number of bits to represent a byte in two's compliment form.
static Class<Byte>	TYPE The java.lang.Class that represents this class.

Constructor Summary

Byte(byte value)
Constructs a new instance of the receiver which represents the byte valued argument.

Byte(String string)
Constructs a new instance of this class given a string.

Method Summary

byte	byteValue() Returns the byte value which the receiver represents
int	compareTo(Byte object) Compares this Byte to the Byte passed.
static Byte	decode(String string) Parses the string argument as if it was a byte value and returns the result.
double	doubleValue() Returns the double value which the receiver represents
boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
float	floatValue() Returns the float value which the receiver represents
int	hashCode() Returns an integer hash code for the receiver.
int	intValue() Returns the int value which the receiver represents
long	longValue() Returns the long value which the receiver represents
static byte	parseByte(String string) Parses the string argument as if it was a byte value and returns the result.
static byte	parseByte(String string, int radix) Parses the string argument as if it was a byte value and returns the result.
short	shortValue() Returns the short value which the receiver represents
String	toString() Returns a string containing a concise, human-readable description of the receiver.
static String	toString(byte value) Returns a string containing a concise, human-readable description of the argument.
static Byte	valueOf(byte b) Returns a Byte instance for the byte value passed.
static Byte	valueOf(String string) Parses the string argument as if it was a byte value and returns a Byte representing the result.
static Byte	valueOf(String string, int radix) Parses the string argument as if it was a byte value and returns a Byte representing the result.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_VALUE

public static final byte MAX_VALUE

Constant for the maximum byte value, 2⁷-1.

See Also:

Constant Field Values

MIN_VALUE

public static final byte MIN_VALUE

Constant for the minimum byte value, -2⁷.

See Also:

Constant Field Values

SIZE

public static final int SIZE

Constant for the number of bits to represent a byte in two's compliment form.

Since:

1.5

See Also:

Constant Field Values

TYPE

public static final Class<Byte> TYPE

The java.lang.Class that represents this class.

Constructor Detail

Byte

public Byte(byte value)

Constructs a new instance of the receiver which represents the byte valued argument.

Parameters:

value - the byte to store in the new instance.

Byte

public Byte(String string)
     throws NumberFormatException

Constructs a new instance of this class given a string.

Parameters:

string - a string representation of a single byte quantity.

Throws:

NumberFormatException - if the argument could not be parsed as a byte quantity.

Method Detail

byteValue

public byte byteValue()

Returns the byte value which the receiver represents

Overrides:

byteValue in class Number

Returns:

byte the value of the receiver.

compareTo

public int compareTo(Byte object)

Compares this Byte to the Byte passed. If this instance's value is equal to the value of the instance passed, then 0 is returned. If this instance's value is less than the value of the instance passed, then a negative value is returned. If this instance's value is greater than the value of the instance passed, then a positive value is returned.

Specified by:

compareTo in interface Comparable<Byte>

Parameters:

object - The instance to compare to.

Returns:

int which should be <0 if the receiver should sort before the argument, 0 if the receiver should sort in the same position as the argument, and >0 if the receiver should sort after the argument.

Throws:

NullPointerException - if object is null.

Since:

1.2

decode

public static Byte decode(String string)
                   throws NumberFormatException

Parses the string argument as if it was a byte value and returns the result. It is an error if the received string does not contain a representation of a single byte quantity. The string may be a hexadecimal ("0x..."), octal ("0..."), or decimal ("...") representation of a byte.

Parameters:

string - a string representation of a single byte quantity.

Returns:

Byte the value represented by the argument

Throws:

NumberFormatException - if the argument could not be parsed as a byte quantity.

doubleValue

public double doubleValue()

Returns the double value which the receiver represents

Specified by:

doubleValue in class Number

Returns:

double the value of the receiver.

equals

public boolean equals(Object object)

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.

In this case, the argument must also be a Byte, and the receiver and argument must represent the same byte value.

Overrides:

equals in class Object

Parameters:

object - the object to compare with this object

Returns:

true if the object is the same as this object false if it is different from this object

See Also:

hashCode()

floatValue

public float floatValue()

Returns the float value which the receiver represents

Specified by:

floatValue in class Number

Returns:

float the value of the receiver.

hashCode

public int hashCode()

Returns an integer hash code for the receiver. Any two objects which answer true when passed to equals must answer the same value for this method.

Overrides:

hashCode in class Object

Returns:

the receiver's hash

See Also:

equals(java.lang.Object)

intValue

public int intValue()

Returns the int value which the receiver represents

Specified by:

intValue in class Number

Returns:

int the value of the receiver.

longValue

public long longValue()

Returns the long value which the receiver represents

Specified by:

longValue in class Number

Returns:

long the value of the receiver.

parseByte

public static byte parseByte(String string)
                      throws NumberFormatException

Parses the string argument as if it was a byte value and returns the result. Throws NumberFormatException if the string does not represent a single byte quantity.

Parameters:

string - a string representation of a single byte quantity.

Returns:

byte the value represented by the argument

Throws:

NumberFormatException - if the argument could not be parsed as a byte quantity.

parseByte

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

Parses the string argument as if it was a byte value and returns the result. Throws NumberFormatException if the string does not represent a single byte quantity. The second argument specifies the radix to use when parsing the value.

Parameters:

string - a string representation of a single byte quantity.

radix - the radix to use when parsing.

Returns:

byte the value represented by the argument

Throws:

NumberFormatException - if the argument could not be parsed as a byte quantity.

shortValue

public short shortValue()

Returns the short value which the receiver represents

Overrides:

shortValue in class Number

Returns:

short the value of the receiver.

toString

public String toString()

Returns a string containing a concise, human-readable description of the receiver.

Overrides:

toString in class Object

Returns:

a printable representation for the receiver.

toString

public static String toString(byte value)

Returns a string containing a concise, human-readable description of the argument.

Parameters:

value - byte the byte to convert.

Returns:

String a printable representation for the byte.

valueOf

public static Byte valueOf(String string)
                    throws NumberFormatException

Parses the string argument as if it was a byte value and returns a Byte representing the result. Throws NumberFormatException if the string cannot be parsed as a byte quantity.

Parameters:

string - a string representation of a single byte quantity.

Returns:

Byte the value represented by the argument

Throws:

NumberFormatException - if the argument could not be parsed as a byte quantity.

valueOf

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

Parses the string argument as if it was a byte value and returns a Byte representing the result. Throws NumberFormatException if the string cannot be parsed as a byte quantity. The second argument specifies the radix to use when parsing the value.

Parameters:

string - a string representation of a single byte quantity.

radix - the radix to use when parsing.

Returns:

Byte the value represented by the argument

Throws:

NumberFormatException - if the argument could not be parsed as a byte quantity.

valueOf

public static Byte valueOf(byte b)

Returns a Byte instance for the byte value passed. This method is preferred over the constructor, as this method may maintain a cache of instances.

Parameters:

b - The byte value.

Returns:

A Byte instance.

Since:

1.5