APIdia Launch Partner
Top Description Inners Fields Constructors Methods
java.lang

public final Class Byte

extends Number
implements Comparable<Byte>, Constable
Class Inheritance
All Implemented Interfaces
java.lang.constant.Constable, java.lang.Comparable
Annotations
@ValueBased
Imports
jdk.internal.misc.CDS, jdk.internal.vm.annotation.AOTSafeClassInitializer, .IntrinsicCandidate, .Stable, java.lang.constant.Constable, .DynamicConstantDesc, java.util.Optional
The Byte class is the wrapper class for values of the primitive type byte. 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.

Since
1.1
See Also
java.lang.Number

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
Byte.ByteCache

Field Summary

Modifier and TypeField and Description
public static final int
BYTES

The number of bytes used to represent a byte value in two's complement binary form.

public static final byte
MAX_VALUE

A constant holding the maximum value a byte can have, 27-1.

public static final byte
MIN_VALUE

A constant holding the minimum value a byte can have, -27.

private static final long
serialVersionUID

Hides java.lang.Number.serialVersionUID.

use serialVersionUID from JDK 1.1.
public static final int
SIZE

The number of bits used to represent a byte value in two's complement binary form.

public static final Class<Byte>
TYPE

The Class instance representing the primitive type byte.

private final byte
value

The value of the Byte.

Constructor Summary

AccessConstructor and Description
public
Byte(byte
the value to be represented by the Byte.
value)
Deprecated since 9. It is rarely appropriate to use this constructor.

Constructs a newly allocated Byte object that represents the specified byte value.

public
Byte(String
the String to be converted to a Byte
s)
Deprecated since 9. It is rarely appropriate to use this constructor.

Constructs a newly allocated Byte object that represents the byte value indicated by the String parameter.

Method Summary

Modifier and TypeMethod and Description
public byte
byteValue()

Overrides java.lang.Number.byteValue.

Returns the value of this Byte as a byte.

public static int

Returns:

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y
compare(byte
the first byte to compare
x, byte
the second byte to compare
y)

Compares two byte values numerically.

public int

Returns:

the value 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).
compareTo(Byte
the Byte to be compared.
anotherByte)

Implements java.lang.Comparable.compareTo.

Compares two Byte objects numerically.

public static int

Returns:

the value 0 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 values
compareUnsigned(byte
the first byte to compare
x, byte
the second byte to compare
y)

Compares two byte values numerically treating the values as unsigned.

public static Byte

Returns:

a Byte object holding the byte value represented by nm
decode(String
the String to decode.
nm)

Decodes a String into a Byte.

public Optional<DynamicConstantDesc<Byte>>

Returns:

an Optional describing the Byte instance
describeConstable()

Implements java.lang.constant.Constable.describeConstable.

Returns an Optional containing the nominal descriptor for this instance.

public double
doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of this Byte as a double after a widening primitive conversion.

public boolean

Returns:

true if the objects are the same; false otherwise.
equals(Object
the object to compare with
obj)

Overrides java.lang.Object.equals.

Compares this object to the specified object.

public float
floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of this Byte as a float after a widening primitive conversion.

public int

Returns:

a hash code value for this Byte
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this Byte; equal to the result of invoking intValue().

public static int

Returns:

a hash code value for a byte value.
hashCode(byte
the value to hash
value)

Returns a hash code for a byte value; compatible with Byte.hashCode().

public int
intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of this Byte as an int after a widening primitive conversion.

public long
longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of this Byte as a long after a widening primitive conversion.

public static byte

Returns:

the byte value represented by the string argument in the specified radix
parseByte(String
the String containing the byte representation to be parsed
s, int
the radix to be used while parsing s
radix)

Parses the string argument as a signed byte in the radix specified by the second argument.

public static byte

Returns:

the byte value represented by the argument in decimal
parseByte(String
a String containing the byte representation to be parsed
s)

Parses the string argument as a signed decimal byte.

public short
shortValue()

Overrides java.lang.Number.shortValue.

Returns the value of this Byte as a short after a widening primitive conversion.

public static String

Returns:

the string representation of the specified byte
toString(byte
the byte to be converted
b)

Returns a new String object representing the specified byte.

public String

Returns:

a string representation of the value of this object in base 10.
toString()

Overrides java.lang.Object.toString.

Returns a String object representing this Byte's value.

public static int

Returns:

the argument converted to int by an unsigned conversion
toUnsignedInt(byte
the value to convert to an unsigned int
x)

Converts the argument to an int by an unsigned conversion.

public static long

Returns:

the argument converted to long by an unsigned conversion
toUnsignedLong(byte
the value to convert to an unsigned long
x)

Converts the argument to a long by an unsigned conversion.

public static Byte

Returns:

a Byte instance representing b.
valueOf(byte
a byte value.
b)

Returns a Byte instance representing the specified byte value.

public static Byte

Returns:

a Byte object holding the value represented by the string argument in the specified radix.
valueOf(String
the string to be parsed
s, int
the radix to be used in interpreting s
radix)

Returns a Byte object holding the value extracted from the specified String when parsed with the radix given by the second argument.

public static Byte

Returns:

a Byte object holding the value represented by the string argument
valueOf(String
the string to be parsed
s)

Returns a Byte object holding the value given by the specified String.

Field Detail

BYTESback to summary
public static final int BYTES

The number of bytes used to represent a byte value in two's complement binary form.

Since
1.8
MAX_VALUEback to summary
public static final byte MAX_VALUE

A constant holding the maximum value a byte can have, 27-1.

MIN_VALUEback to summary
public static final byte MIN_VALUE

A constant holding the minimum value a byte can have, -27.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Number.serialVersionUID.

use serialVersionUID from JDK 1.1. for interoperability

Annotations
@Serial
SIZEback to summary
public static final int SIZE

The number of bits used to represent a byte value in two's complement binary form.

Since
1.5
TYPEback to summary
public static final Class<Byte> TYPE

The Class instance representing the primitive type byte.

valueback to summary
private final byte value

The value of the Byte.

Constructor Detail

Byteback to summary
public Byte(byte value)

Deprecated

since 9.

It is rarely appropriate to use this constructor. The static factory valueOf(byte) is generally a better choice, as it is likely to yield significantly better space and time performance.

Constructs a newly allocated Byte object that represents the specified byte value.

Parameters
value:byte

the value to be represented by the Byte.

Annotations
@Deprecated
since:9
Byteback to summary
public Byte(String s) throws NumberFormatException

Deprecated

since 9.

It is rarely appropriate to use this constructor. Use parseByte(String) to convert a string to a byte primitive, or use valueOf(String) to convert a string to a Byte object.

Constructs a newly allocated 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.

Parameters
s:String

the String to be converted to a Byte

Annotations
@Deprecated
since:9
Exceptions
NumberFormatException:
if the String does not contain a parsable byte.

Method Detail

byteValueback to summary
public byte byteValue()

Overrides java.lang.Number.byteValue.

Returns the value of this Byte as a byte.

Annotations
@IntrinsicCandidate
compareback to summary
public static int compare(byte x, byte y)

Compares two byte values numerically. The value returned is identical to what would be returned by: 

   Byte.valueOf(x).compareTo(Byte.valueOf(y))
Parameters
x:byte

the first byte to compare

y:byte

the second byte to compare

Returns:int

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

Since
1.7
compareToback to summary
public int compareTo(Byte anotherByte)

Implements java.lang.Comparable.compareTo.

Compares two Byte objects numerically.

Parameters
anotherByte:Byte

the Byte to be compared.

Returns:int

the value 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).

Since
1.2
compareUnsignedback to summary
public static int compareUnsigned(byte x, byte y)

Compares two byte values numerically treating the values as unsigned.

Parameters
x:byte

the first byte to compare

y:byte

the second byte to compare

Returns:int

the value 0 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 values

Since
9
decodeback to summary
public static Byte decode(String nm) throws NumberFormatException

Decodes a String into a Byte. Accepts decimal, hexadecimal, and octal numbers given by the following grammar:

DecodableString:
Signopt DecimalNumeral
Signopt 0x HexDigits
Signopt 0X HexDigits
Signopt # HexDigits
Signopt 0 OctalDigits
Sign:
-
+
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.

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.

Parameters
nm:String

the String to decode.

Returns:Byte

a Byte object holding the byte value represented by nm

Exceptions
NumberFormatException:
if the String does not contain a parsable byte.
See Also
java.lang.Byte#parseByte(java.lang.String, int)
describeConstableback to summary
public Optional<DynamicConstantDesc<Byte>> describeConstable()

Implements java.lang.constant.Constable.describeConstable.

Returns an Optional containing the nominal descriptor for this instance.

Returns:Optional<DynamicConstantDesc<Byte>>

an Optional describing the Byte instance

Annotations
@Override
Since
15
doubleValueback to summary
public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of this Byte as a double after a widening primitive conversion.

Java Language Specification
5.1.2 Widening Primitive Conversion
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Compares this object to the specified object. The result is true if and only if the argument is not null and is a Byte object that contains the same byte value as this object.

Parameters
obj:Object

the object to compare with

Returns:boolean

true if the objects are the same; false otherwise.

floatValueback to summary
public float floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of this Byte as a float after a widening primitive conversion.

Java Language Specification
5.1.2 Widening Primitive Conversion
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this Byte; equal to the result of invoking intValue().

Returns:int

a hash code value for this Byte

Annotations
@Override
hashCodeback to summary
public static int hashCode(byte value)

Returns a hash code for a byte value; compatible with Byte.hashCode().

Parameters
value:byte

the value to hash

Returns:int

a hash code value for a byte value.

Since
1.8
intValueback to summary
public int intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of this Byte as an int after a widening primitive conversion.

Java Language Specification
5.1.2 Widening Primitive Conversion
longValueback to summary
public long longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of this Byte as a long after a widening primitive conversion.

Java Language Specification
5.1.2 Widening Primitive Conversion
parseByteback to summary
public static byte parseByte(String s, int radix) throws NumberFormatException

Parses the string argument as a signed 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 java.lang.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:

  • The first argument is null or is a string of length zero.
  • The radix is either smaller than java.lang.Character#MIN_RADIX or larger than java.lang.Character#MAX_RADIX.
  • Any character of the string is not a digit of the specified radix, except that the first character may be a minus sign '-' ('\u002D') or plus sign '+' ('\u002B') provided that the string is longer than length 1.
  • The value represented by the string is not a value of type byte.
Parameters
s:String

the String containing the byte representation to be parsed

radix:int

the radix to be used while parsing s

Returns:byte

the byte value represented by the string argument in the specified radix

Exceptions
NumberFormatException:
If the string does not contain a parsable byte.
parseByteback to summary
public static byte parseByte(String s) throws NumberFormatException

Parses the string argument as a signed decimal 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.

Parameters
s:String

a String containing the byte representation to be parsed

Returns:byte

the byte value represented by the argument in decimal

Exceptions
NumberFormatException:
if the string does not contain a parsable byte.
shortValueback to summary
public short shortValue()

Overrides java.lang.Number.shortValue.

Returns the value of this Byte as a short after a widening primitive conversion.

Java Language Specification
5.1.2 Widening Primitive Conversion
toStringback to summary
public static String toString(byte b)

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

Parameters
b:byte

the byte to be converted

Returns:String

the string representation of the specified byte

See Also
java.lang.Integer#toString(int)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a 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 java.lang.Byte#toString(byte) method.

Returns:String

a string representation of the value of this object in base 10.

Annotations
@Override
toUnsignedIntback to summary
public static int toUnsignedInt(byte x)

Converts the argument to an 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.

Parameters
x:byte

the value to convert to an unsigned int

Returns:int

the argument converted to int by an unsigned conversion

Since
1.8
toUnsignedLongback to summary
public static long toUnsignedLong(byte x)

Converts the argument to a 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.

Parameters
x:byte

the value to convert to an unsigned long

Returns:long

the argument converted to long by an unsigned conversion

Since
1.8
valueOfback to summary
public static Byte valueOf(byte b)

Returns a 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.

Parameters
b:byte

a byte value.

Returns:Byte

a Byte instance representing b.

Annotations
@IntrinsicCandidate
Since
1.5
valueOfback to summary
public static Byte valueOf(String s, int radix) throws NumberFormatException

Returns a 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))
Parameters
s:String

the string to be parsed

radix:int

the radix to be used in interpreting s

Returns:Byte

a Byte object holding the value represented by the string argument in the specified radix.

Exceptions
NumberFormatException:
If the String does not contain a parsable byte.
valueOfback to summary
public static Byte valueOf(String s) throws NumberFormatException

Returns a 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))
Parameters
s:String

the string to be parsed

Returns:Byte

a Byte object holding the value represented by the string argument

Exceptions
NumberFormatException:
If the String does not contain a parsable byte.
java.lang back to summary

private final Class Byte.ByteCache

extends Object
Class Inheritance
Annotations
@AOTSafeClassInitializer

Field Summary

Modifier and TypeField and Description
pack-priv static Byte[]
archivedCache

pack-priv static final Byte[]
cache

Constructor Summary

AccessConstructor and Description
private
ByteCache()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

archivedCacheback to summary
pack-priv static Byte[] archivedCache
cacheback to summary
pack-priv static final Byte[] cache
Annotations
@Stable

Constructor Detail

ByteCacheback to summary
private ByteCache()