java.lang
Class Byte

java.lang.Object
  extended by java.lang.Number
      extended by java.lang.Byte
All Implemented Interfaces:
Comparable

public final class Byte
extends Number
implements Comparable

Instances of class Byte represent primitive byte values. Additionally, this class provides various helper functions and variables useful to bytes.

Since:
1.1

Field Summary
static byte MAX_VALUE
          The maximum value a byte can represent is 127 (or 27 - 1).
static byte MIN_VALUE
          The minimum value a byte can represent is -128 (or -27).
static int SIZE
          The number of bits needed to represent a byte.
static Class TYPE
          The primitive type byte is represented by this Class object.
 
Constructor Summary
Byte(byte value)
          Create a Byte object representing the value of the byte argument.
Byte(String s)
          Create a Byte object representing the value specified by the String argument
 
Method Summary
 byte byteValue()
          Return the value of this Byte.
 int compareTo(Byte b)
          Compare two Bytes numerically by comparing their byte values.
 int compareTo(Object o)
          Behaves like compareTo(Byte) unless the Object is not a Byte.
static Byte decode(String s)
          Convert the specified String into a Byte.
 double doubleValue()
          Return the value of this Byte as a double.
 boolean equals(Object obj)
          Returns true if obj is an instance of Byte and represents the same byte value.
 float floatValue()
          Return the value of this Byte as a float.
 int hashCode()
          Return a hashcode representing this Object.
 int intValue()
          Return the value of this Byte as an int.
 long longValue()
          Return the value of this Byte as a long.
static byte parseByte(String s)
          Converts the specified String into a byte.
static byte parseByte(String s, int radix)
          Converts the specified String into an int using the specified radix (base).
 short shortValue()
          Return the value of this Byte as a short.
 String toString()
          Converts the Byte value to a String and assumes a radix of 10.
static String toString(byte b)
          Converts the byte to a String and assumes a radix of 10.
static Byte valueOf(byte val)
          Returns a Byte object wrapping the value.
static Byte valueOf(String s)
          Creates a new Byte object using the String, assuming a radix of 10.
static Byte valueOf(String s, int radix)
          Creates a new Byte object using the String and specified radix (base).
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MIN_VALUE

public static final byte MIN_VALUE
The minimum value a byte can represent is -128 (or -27).

See Also:
Constant Field Values

MAX_VALUE

public static final byte MAX_VALUE
The maximum value a byte can represent is 127 (or 27 - 1).

See Also:
Constant Field Values

TYPE

public static final Class TYPE
The primitive type byte is represented by this Class object.


SIZE

public static final int SIZE
The number of bits needed to represent a byte.

Since:
1.5
See Also:
Constant Field Values
Constructor Detail

Byte

public Byte(byte value)
Create a Byte object representing the value of the byte argument.

Parameters:
value - the value to use

Byte

public Byte(String s)
Create a Byte object representing the value specified by the String argument

Parameters:
s - the string to convert
Throws:
NumberFormatException - if the String does not contain a byte
See Also:
valueOf(String)
Method Detail

toString

public static String toString(byte b)
Converts the byte to a String and assumes a radix of 10.

Parameters:
b - the byte to convert to String
Returns:
the String representation of the argument

parseByte

public static byte parseByte(String s)
Converts the specified String into a byte. This function assumes a radix of 10.

Parameters:
s - the String to convert
Returns:
the byte value of s
Throws:
NumberFormatException - if s cannot be parsed as a byte
See Also:
parseByte(String)

parseByte

public static byte parseByte(String s,
                             int radix)
Converts the specified String into an int using the specified radix (base). The string must not be null or empty. It may begin with an optional '-', which will negate the answer, provided that there are also valid digits. Each digit is parsed as if by Character.digit(d, radix), and must be in the range 0 to radix - 1. Finally, the result must be within MIN_VALUE to MAX_VALUE, inclusive. Unlike Double.parseDouble, you may not have a leading '+'.

Parameters:
s - the String to convert
radix - the radix (base) to use in the conversion
Returns:
the String argument converted to byte
Throws:
NumberFormatException - if s cannot be parsed as a byte

valueOf

public static Byte valueOf(String s,
                           int radix)
Creates a new Byte object using the String and specified radix (base).

Parameters:
s - the String to convert
radix - the radix (base) to convert with
Returns:
the new Byte
Throws:
NumberFormatException - if s cannot be parsed as a byte
See Also:
parseByte(String, int)

valueOf

public static Byte valueOf(String s)
Creates a new Byte object using the String, assuming a radix of 10.

Parameters:
s - the String to convert
Returns:
the new Byte
Throws:
NumberFormatException - if s cannot be parsed as a byte
See Also:
Byte(String), parseByte(String)

valueOf

public static Byte valueOf(byte val)
Returns a Byte object wrapping the value. In contrast to the Byte constructor, this method will cache some values. It is used by boxing conversion.

Parameters:
val - the value to wrap
Returns:
the Byte
Since:
1.5

decode

public static Byte decode(String s)
Convert the specified String into a Byte. The String may represent decimal, hexadecimal, or octal numbers.

The extended BNF grammar is as follows:

 DecodableString:
      ( [ - ] DecimalNumber )
    | ( [ - ] ( 0x | 0X
              | # ) { HexDigit }+ )
    | ( [ - ] 0 { OctalDigit } )
 DecimalNumber:
        DecimalDigit except '0' { DecimalDigit }
 DecimalDigit:
        Character.digit(d, 10) has value 0 to 9
 OctalDigit:
        Character.digit(d, 8) has value 0 to 7
 DecimalDigit:
        Character.digit(d, 16) has value 0 to 15
 
Finally, the value must be in the range MIN_VALUE to MAX_VALUE, or an exception is thrown.

Parameters:
s - the String to interpret
Returns:
the value of the String as a Byte
Throws:
NumberFormatException - if s cannot be parsed as a byte
NullPointerException - if s is null
See Also:
Integer.decode(String)

byteValue

public byte byteValue()
Return the value of this Byte.

Overrides:
byteValue in class Number
Returns:
the byte value

shortValue

public short shortValue()
Return the value of this Byte as a short.

Overrides:
shortValue in class Number
Returns:
the short value

intValue

public int intValue()
Return the value of this Byte as an int.

Specified by:
intValue in class Number
Returns:
the int value

longValue

public long longValue()
Return the value of this Byte as a long.

Specified by:
longValue in class Number
Returns:
the long value

floatValue

public float floatValue()
Return the value of this Byte as a float.

Specified by:
floatValue in class Number
Returns:
the float value

doubleValue

public double doubleValue()
Return the value of this Byte as a double.

Specified by:
doubleValue in class Number
Returns:
the double value

toString

public String toString()
Converts the Byte value to a String and assumes a radix of 10.

Overrides:
toString in class Object
Returns:
the String representation of this Byte
See Also:
Integer.toString()

hashCode

public int hashCode()
Return a hashcode representing this Object. Byte's hash code is simply its value.

Overrides:
hashCode in class Object
Returns:
this Object's hash code
See Also:
Object.equals(Object), System.identityHashCode(Object)

equals

public boolean equals(Object obj)
Returns true if obj is an instance of Byte and represents the same byte value.

Overrides:
equals in class Object
Parameters:
obj - the object to compare
Returns:
whether these Objects are semantically equal
See Also:
Object.hashCode()

compareTo

public int compareTo(Byte b)
Compare two Bytes numerically by comparing their byte values. The result is positive if the first is greater, negative if the second is greater, and 0 if the two are equal.

Parameters:
b - the Byte to compare
Returns:
the comparison
Since:
1.2

compareTo

public int compareTo(Object o)
Behaves like compareTo(Byte) unless the Object is not a Byte.

Specified by:
compareTo in interface Comparable
Parameters:
o - the object to compare
Returns:
the comparison
Throws:
ClassCastException - if the argument is not a Byte
Since:
1.2
See Also:
compareTo(Byte), Comparable