java.lang

Class Byte

Implemented Interfaces:
Comparable<T>, Serializable

public final class Byte
extends Number
implements Comparable<T>

Instances of class Byte represent primitive byte values. Additionally, this class provides various helper functions and variables useful to bytes.
Since:
1.1
See Also:
Serialized Form

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.
static int
compare(byte x, byte y)
Compares two unboxed byte values.
int
compareTo(Byte b)
Compare two Bytes numerically by comparing their byte values.
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.Number

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_VALUE

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

MIN_VALUE

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

SIZE

public static final int SIZE
The number of bits needed to represent a byte.
Field Value:
8
Since:
1.5

TYPE

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

Constructor Details

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

Method Details

byteValue

public byte byteValue()
Return the value of this Byte.
Overrides:
byteValue in interface Number
Returns:
the byte value

compare

public static int compare(byte x,
                          byte y)
Compares two unboxed 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:
x - First value to compare.
y - Second value to compare.
Returns:
positive int if the first value is greater, negative if the second is greater, and 0 if the two are equal.
Since:
1.7

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

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

doubleValue

public double doubleValue()
Return the value of this Byte as a double.
Overrides:
doubleValue in interface Number
Returns:
the double value

equals

public boolean equals(Object obj)
Returns true if obj is an instance of Byte and represents the same byte value.
Overrides:
equals in interface Object
Parameters:
obj - the object to compare
Returns:
whether these Objects are semantically equal

floatValue

public float floatValue()
Return the value of this Byte as a float.
Overrides:
floatValue in interface Number
Returns:
the float value

hashCode

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

intValue

public int intValue()
Return the value of this Byte as an int.
Overrides:
intValue in interface Number
Returns:
the int value

longValue

public long longValue()
Return the value of this Byte as a long.
Overrides:
longValue in interface Number
Returns:
the long value

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

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

shortValue

public short shortValue()
Return the value of this Byte as a short.
Overrides:
shortValue in interface Number
Returns:
the short value

toString

public String toString()
Converts the Byte value to a String and assumes a radix of 10.
Overrides:
toString in interface Object
Returns:
the String representation of this Byte

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

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

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

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

Byte.java -- object wrapper for byte Copyright (C) 1998, 2001, 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.