Serializable
, Comparable<Byte>
, Constable
public final class Byte extends Number implements Comparable<Byte>, Constable
Byte
class wraps a value of primitive type byte
in an object. An object of type Byte
contains a single field whose type is byte
. In addition, this class provides several methods for converting a byte
to a String
and a String
to a
byte
, as well as other constants and methods useful when dealing with a byte
.
This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail.
Modifier and Type | Field | Description |
---|---|---|
static final int |
BYTES |
The number of bytes used to represent a byte value in two's complement binary form. |
static final byte |
MAX_VALUE |
A constant holding the maximum value a byte can have, 27-1. |
static final byte |
MIN_VALUE |
A constant holding the minimum value a byte can have, -27. |
static final int |
SIZE |
The number of bits used to represent a byte value in two's complement binary form. |
static final Class |
TYPE |
The Class instance representing the primitive type byte . |
Constructor | Description |
---|---|
Byte |
Deprecated, for removal: This API element is subject to removal in a future version. It is rarely appropriate to use this constructor. |
Byte |
Deprecated, for removal: This API element is subject to removal in a future version. It is rarely appropriate to use this constructor. |
Modifier and Type | Method | Description |
---|---|---|
byte |
byteValue() |
Returns the value of this Byte as a byte . |
static int |
compare |
Compares two byte values numerically. |
int |
compareTo |
Compares two Byte objects numerically. |
static int |
compareUnsigned |
Compares two byte values numerically treating the values as unsigned. |
static Byte |
decode |
Decodes a String into a Byte . |
Optional |
describeConstable() |
Returns an Optional containing the nominal descriptor for this instance. |
double |
doubleValue() |
Returns the value of this Byte as a double after a widening primitive conversion. |
boolean |
equals |
Compares this object to the specified object. |
float |
floatValue() |
Returns the value of this Byte as a float after a widening primitive conversion. |
int |
hashCode() |
Returns a hash code for this Byte ; equal to the result of invoking intValue() . |
static int |
hashCode |
Returns a hash code for a byte value; compatible with Byte.hashCode() . |
int |
intValue() |
Returns the value of this Byte as an int after a widening primitive conversion. |
long |
longValue() |
Returns the value of this Byte as a long after a widening primitive conversion. |
static byte |
parseByte |
Parses the string argument as a signed decimal
byte . |
static byte |
parseByte |
Parses the string argument as a signed byte in the radix specified by the second argument. |
short |
shortValue() |
Returns the value of this Byte as a short after a widening primitive conversion. |
String |
toString() |
Returns a String object representing this Byte 's value. |
static String |
toString |
Returns a new String object representing the specified byte . |
static int |
toUnsignedInt |
Converts the argument to an int by an unsigned conversion. |
static long |
toUnsignedLong |
Converts the argument to a long by an unsigned conversion. |
static Byte |
valueOf |
Returns a Byte instance representing the specified byte value. |
static Byte |
valueOf |
Returns a Byte object holding the value given by the specified String . |
static Byte |
valueOf |
Returns a Byte object holding the value extracted from the specified String when parsed with the radix given by the second argument. |
public static final byte MIN_VALUE
byte
can have, -27.public static final byte MAX_VALUE
byte
can have, 27-1.public static final Class<Byte> TYPE
Class
instance representing the primitive type byte
.public static final int SIZE
byte
value in two's complement binary form.public static final int BYTES
byte
value in two's complement binary form.@Deprecated(since="9", forRemoval=true) public Byte(byte value)
valueOf(byte)
is generally a better choice, as it is likely to yield significantly better space and time performance.Byte
object that represents the specified byte
value.value
- the value to be represented by the Byte
.@Deprecated(since="9", forRemoval=true) public Byte(String s) throws NumberFormatException
parseByte(String)
to convert a string to a byte
primitive, or use valueOf(String)
to convert a string to a Byte
object.Byte
object that represents the byte
value indicated by the String
parameter. The string is converted to a byte
value in exactly the manner used by the parseByte
method for radix 10.s
- the String
to be converted to a Byte
NumberFormatException
- if the String
does not contain a parsable byte
.public static String toString(byte b)
String
object representing the specified byte
. The radix is assumed to be 10.b
- the byte
to be convertedbyte
public Optional<DynamicConstantDesc<Byte>> describeConstable()
Optional
containing the nominal descriptor for this instance.describeConstable
in interface Constable
Optional
describing the Byte instancepublic static Byte valueOf(byte b)
Byte
instance representing the specified byte
value. If a new Byte
instance is not required, this method should generally be used in preference to the constructor Byte(byte)
, as this method is likely to yield significantly better space and time performance since all byte values are cached.b
- a byte value.Byte
instance representing b
.public static byte parseByte(String s, int radix) throws NumberFormatException
byte
in the radix specified by the second argument. The characters in the string must all be digits, of the specified radix (as determined by whether Character.digit(char, int)
returns a nonnegative value) except that the first character may be an ASCII minus sign '-'
('\u002D'
) to indicate a negative value or an ASCII plus sign '+'
('\u002B'
) to indicate a positive value. The resulting byte
value is returned. An exception of type NumberFormatException
is thrown if any of the following situations occurs:
null
or is a string of length zero. Character.MIN_RADIX
or larger than Character.MAX_RADIX
. '-'
('\u002D'
) or plus sign '+'
('\u002B'
) provided that the string is longer than length 1. byte
. s
- the String
containing the byte
representation to be parsedradix
- the radix to be used while parsing s
byte
value represented by the string argument in the specified radixNumberFormatException
- If the string does not contain a parsable byte
.public static byte parseByte(String s) throws NumberFormatException
byte
. The characters in the string must all be decimal digits, except that the first character may be an ASCII minus sign '-'
('\u002D'
) to indicate a negative value or an ASCII plus sign '+'
('\u002B'
) to indicate a positive value. The resulting byte
value is returned, exactly as if the argument and the radix 10 were given as arguments to the parseByte(java.lang.String, int)
method.s
- a String
containing the byte
representation to be parsedbyte
value represented by the argument in decimalNumberFormatException
- if the string does not contain a parsable byte
.public static Byte valueOf(String s, int radix) throws NumberFormatException
Byte
object holding the value extracted from the specified String
when parsed with the radix given by the second argument. The first argument is interpreted as representing a signed byte
in the radix specified by the second argument, exactly as if the argument were given to the parseByte(java.lang.String, int)
method. The result is a Byte
object that represents the byte
value specified by the string. In other words, this method returns a Byte
object equal to the value of:
Byte.valueOf(Byte.parseByte(s, radix))
s
- the string to be parsedradix
- the radix to be used in interpreting s
Byte
object holding the value represented by the string argument in the specified radix.NumberFormatException
- If the String
does not contain a parsable byte
.public static Byte valueOf(String s) throws NumberFormatException
Byte
object holding the value given by the specified String
. The argument is interpreted as representing a signed decimal byte
, exactly as if the argument were given to the parseByte(java.lang.String)
method. The result is a Byte
object that represents the byte
value specified by the string. In other words, this method returns a Byte
object equal to the value of:
Byte.valueOf(Byte.parseByte(s))
s
- the string to be parsedByte
object holding the value represented by the string argumentNumberFormatException
- If the String
does not contain a parsable byte
.public static Byte decode(String nm) throws NumberFormatException
String
into a Byte
. Accepts decimal, hexadecimal, and octal numbers given by the following grammar: DecimalNumeral, HexDigits, and OctalDigits are as defined in section 3.10.1 of The Java Language Specification, except that underscores are not accepted between digits.
- DecodableString:
- Signopt DecimalNumeral
- Signopt
0x
HexDigits- Signopt
0X
HexDigits- Signopt
#
HexDigits- Signopt
0
OctalDigits- Sign:
-
+
The sequence of characters following an optional sign and/or radix specifier ("0x
", "0X
", "#
", or leading zero) is parsed as by the
Byte.parseByte
method with the indicated radix (10, 16, or 8). This sequence of characters must represent a positive value or a NumberFormatException
will be thrown. The result is negated if first character of the specified String
is the minus sign. No whitespace characters are permitted in the String
.
nm
- the String
to decode.Byte
object holding the byte
value represented by nm
NumberFormatException
- if the String
does not contain a parsable byte
.public byte byteValue()
Byte
as a byte
.public short shortValue()
Byte
as a short
after a widening primitive conversion.shortValue
in class Number
short
.public int intValue()
Byte
as an int
after a widening primitive conversion.intValue
in class Number
int
.public long longValue()
Byte
as a long
after a widening primitive conversion.longValue
in class Number
long
.public float floatValue()
Byte
as a float
after a widening primitive conversion.floatValue
in class Number
float
.public double doubleValue()
Byte
as a double
after a widening primitive conversion.doubleValue
in class Number
double
.public String toString()
String
object representing this Byte
's value. The value is converted to signed decimal representation and returned as a string, exactly as if the byte
value were given as an argument to the toString(byte)
method.public int hashCode()
Byte
; equal to the result of invoking intValue()
.public static int hashCode(byte value)
byte
value; compatible with Byte.hashCode()
.value
- the value to hashbyte
value.public boolean equals(Object obj)
true
if and only if the argument is not null
and is a Byte
object that contains the same byte
value as this object.public int compareTo(Byte anotherByte)
Byte
objects numerically.compareTo
in interface Comparable<Byte>
anotherByte
- the Byte
to be compared.0
if this Byte
is equal to the argument Byte
; a value less than 0
if this Byte
is numerically less than the argument Byte
; and a value greater than 0
if this Byte
is numerically greater than the argument Byte
(signed comparison).public static int compare(byte x, byte y)
byte
values numerically. The value returned is identical to what would be returned by: Byte.valueOf(x).compareTo(Byte.valueOf(y))
x
- the first byte
to comparey
- the second byte
to compare0
if x == y
; a value less than 0
if x < y
; and a value greater than 0
if x > y
public static int compareUnsigned(byte x, byte y)
byte
values numerically treating the values as unsigned.x
- the first byte
to comparey
- the second byte
to compare0
if x == y
; a value less than 0
if x < y
as unsigned values; and a value greater than 0
if x > y
as unsigned valuespublic static int toUnsignedInt(byte x)
int
by an unsigned conversion. In an unsigned conversion to an int
, the high-order 24 bits of the int
are zero and the low-order 8 bits are equal to the bits of the byte
argument. Consequently, zero and positive byte
values are mapped to a numerically equal int
value and negative
byte
values are mapped to an int
value equal to the input plus 28.x
- the value to convert to an unsigned int
int
by an unsigned conversionpublic static long toUnsignedLong(byte x)
long
by an unsigned conversion. In an unsigned conversion to a long
, the high-order 56 bits of the long
are zero and the low-order 8 bits are equal to the bits of the byte
argument. Consequently, zero and positive byte
values are mapped to a numerically equal long
value and negative
byte
values are mapped to a long
value equal to the input plus 28.x
- the value to convert to an unsigned long
long
by an unsigned conversion
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Byte.html