- All Implemented Interfaces:
- Serializable,- 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.
- Since:
- 1.1
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intThe number of bytes used to represent abytevalue in two's complement binary form.static final byteA constant holding the maximum value abytecan have, 27-1.static final byteA constant holding the minimum value abytecan have, -27.static final intThe number of bits used to represent abytevalue in two's complement binary form.TheClassinstance representing the primitive typebyte.
- 
Constructor SummaryConstructorsConstructorDescriptionByte(byte value) Deprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor.Deprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor.
- 
Method SummaryModifier and TypeMethodDescriptionbyteReturns the value of thisByteas abyte.static intcompare(byte x, byte y) Compares twobytevalues numerically.intCompares twoByteobjects numerically.static intcompareUnsigned(byte x, byte y) Compares twobytevalues numerically treating the values as unsigned.static ByteDecodes aStringinto aByte.Returns anOptionalcontaining the nominal descriptor for this instance.doubleReturns the value of thisByteas adoubleafter a widening primitive conversion.booleanCompares this object to the specified object.floatReturns the value of thisByteas afloatafter a widening primitive conversion.inthashCode()Returns a hash code for thisByte; equal to the result of invokingintValue().static inthashCode(byte value) Returns a hash code for abytevalue; compatible withByte.hashCode().intintValue()Returns the value of thisByteas anintafter a widening primitive conversion.longReturns the value of thisByteas alongafter a widening primitive conversion.static byteParses the string argument as a signed decimalbyte.static byteParses the string argument as a signedbytein the radix specified by the second argument.shortReturns the value of thisByteas ashortafter a widening primitive conversion.toString()Returns aStringobject representing thisByte's value.static StringtoString(byte b) Returns a newStringobject representing the specifiedbyte.static inttoUnsignedInt(byte x) Converts the argument to anintby an unsigned conversion.static longtoUnsignedLong(byte x) Converts the argument to alongby an unsigned conversion.static BytevalueOf(byte b) Returns aByteinstance representing the specifiedbytevalue.static ByteReturns aByteobject holding the value given by the specifiedString.static ByteReturns aByteobject holding the value extracted from the specifiedStringwhen parsed with the radix given by the second argument.
- 
Field Details- 
MIN_VALUEpublic static final byte MIN_VALUEA constant holding the minimum value abytecan have, -27.- See Also:
 
- 
MAX_VALUEpublic static final byte MAX_VALUEA constant holding the maximum value abytecan have, 27-1.- See Also:
 
- 
TYPETheClassinstance representing the primitive typebyte.
- 
SIZEpublic static final int SIZEThe number of bits used to represent abytevalue in two's complement binary form.- Since:
- 1.5
- See Also:
 
- 
BYTESpublic static final int BYTESThe number of bytes used to represent abytevalue in two's complement binary form.- Since:
- 1.8
- See Also:
 
 
- 
- 
Constructor Details- 
ByteDeprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor. The static factoryvalueOf(byte)is generally a better choice, as it is likely to yield significantly better space and time performance.Constructs a newly allocatedByteobject that represents the specifiedbytevalue.- Parameters:
- value- the value to be represented by the- Byte.
 
- 
ByteDeprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor. UseparseByte(String)to convert a string to abyteprimitive, or usevalueOf(String)to convert a string to aByteobject.Constructs a newly allocatedByteobject that represents thebytevalue indicated by theStringparameter. The string is converted to abytevalue in exactly the manner used by theparseBytemethod for radix 10.- Parameters:
- s- the- Stringto be converted to a- Byte
- Throws:
- NumberFormatException- if the- Stringdoes not contain a parsable- byte.
 
 
- 
- 
Method Details- 
toStringReturns a newStringobject representing the specifiedbyte. The radix is assumed to be 10.- Parameters:
- b- the- byteto be converted
- Returns:
- the string representation of the specified byte
- See Also:
 
- 
describeConstableReturns anOptionalcontaining the nominal descriptor for this instance.- Specified by:
- describeConstablein interface- Constable
- Returns:
- an Optionaldescribing the Byte instance
- Since:
- 15
 
- 
valueOfReturns aByteinstance representing the specifiedbytevalue. If a newByteinstance is not required, this method should generally be used in preference to the constructorByte(byte), as this method is likely to yield significantly better space and time performance since all byte values are cached.- Parameters:
- b- a byte value.
- Returns:
- a Byteinstance representingb.
- Since:
- 1.5
 
- 
parseByteParses the string argument as a signedbytein the radix specified by the second argument. The characters in the string must all be digits, of the specified radix (as determined by whetherCharacter.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 resultingbytevalue is returned.An exception of type NumberFormatExceptionis thrown if any of the following situations occurs:-  The first argument is nullor is a string of length zero.
-  The radix is either smaller than Character.MIN_RADIXor larger thanCharacter.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- the- Stringcontaining the- byterepresentation to be parsed
- radix- the radix to be used while parsing- s
- Returns:
- the bytevalue represented by the string argument in the specified radix
- Throws:
- NumberFormatException- If the string does not contain a parsable- byte.
 
-  The first argument is 
- 
parseByteParses the string argument as a signed decimalbyte. 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 resultingbytevalue is returned, exactly as if the argument and the radix 10 were given as arguments to theparseByte(java.lang.String, int)method.- Parameters:
- s- a- Stringcontaining the- byterepresentation to be parsed
- Returns:
- the bytevalue represented by the argument in decimal
- Throws:
- NumberFormatException- if the string does not contain a parsable- byte.
 
- 
valueOfReturns aByteobject holding the value extracted from the specifiedStringwhen parsed with the radix given by the second argument. The first argument is interpreted as representing a signedbytein the radix specified by the second argument, exactly as if the argument were given to theparseByte(java.lang.String, int)method. The result is aByteobject that represents thebytevalue specified by the string.In other words, this method returns a Byteobject equal to the value of:new Byte(Byte.parseByte(s, radix))- Parameters:
- s- the string to be parsed
- radix- the radix to be used in interpreting- s
- Returns:
- a Byteobject holding the value represented by the string argument in the specified radix.
- Throws:
- NumberFormatException- If the- Stringdoes not contain a parsable- byte.
 
- 
valueOfReturns aByteobject holding the value given by the specifiedString. The argument is interpreted as representing a signed decimalbyte, exactly as if the argument were given to theparseByte(java.lang.String)method. The result is aByteobject that represents thebytevalue specified by the string.In other words, this method returns a Byteobject equal to the value of:new Byte(Byte.parseByte(s))- Parameters:
- s- the string to be parsed
- Returns:
- a Byteobject holding the value represented by the string argument
- Throws:
- NumberFormatException- If the- Stringdoes not contain a parsable- byte.
 
- 
decodeDecodes aStringinto aByte. 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
0xHexDigits
- Signopt
0XHexDigits
- Signopt
#HexDigits
- Signopt
0OctalDigits
- Signopt
- Sign:
- -- +
 The sequence of characters following an optional sign and/or radix specifier (" 0x", "0X", "#", or leading zero) is parsed as by theByte.parseBytemethod with the indicated radix (10, 16, or 8). This sequence of characters must represent a positive value or aNumberFormatExceptionwill be thrown. The result is negated if first character of the specifiedStringis the minus sign. No whitespace characters are permitted in theString.- Parameters:
- nm- the- Stringto decode.
- Returns:
- a Byteobject holding thebytevalue represented bynm
- Throws:
- NumberFormatException- if the- Stringdoes not contain a parsable- byte.
- See Also:
 
- 
byteValuepublic byte byteValue()Returns the value of thisByteas abyte.
- 
shortValuepublic short shortValue()Returns the value of thisByteas ashortafter a widening primitive conversion.- Overrides:
- shortValuein class- Number
- Returns:
- the numeric value represented by this object after conversion
          to type short.
- See Java Language Specification:
- 
5.1.2 Widening Primitive Conversion
 
- 
intValuepublic int intValue()Returns the value of thisByteas anintafter a widening primitive conversion.- Specified by:
- intValuein class- Number
- Returns:
- the numeric value represented by this object after conversion
          to type int.
- See Java Language Specification:
- 
5.1.2 Widening Primitive Conversion
 
- 
longValuepublic long longValue()Returns the value of thisByteas alongafter a widening primitive conversion.- Specified by:
- longValuein class- Number
- Returns:
- the numeric value represented by this object after conversion
          to type long.
- See Java Language Specification:
- 
5.1.2 Widening Primitive Conversion
 
- 
floatValuepublic float floatValue()Returns the value of thisByteas afloatafter a widening primitive conversion.- Specified by:
- floatValuein class- Number
- Returns:
- the numeric value represented by this object after conversion
          to type float.
- See Java Language Specification:
- 
5.1.2 Widening Primitive Conversion
 
- 
doubleValuepublic double doubleValue()Returns the value of thisByteas adoubleafter a widening primitive conversion.- Specified by:
- doubleValuein class- Number
- Returns:
- the numeric value represented by this object after conversion
          to type double.
- See Java Language Specification:
- 
5.1.2 Widening Primitive Conversion
 
- 
toStringReturns aStringobject representing thisByte's value. The value is converted to signed decimal representation and returned as a string, exactly as if thebytevalue were given as an argument to thetoString(byte)method.
- 
hashCodepublic int hashCode()Returns a hash code for thisByte; equal to the result of invokingintValue().
- 
hashCodepublic static int hashCode(byte value) Returns a hash code for abytevalue; compatible withByte.hashCode().- Parameters:
- value- the value to hash
- Returns:
- a hash code value for a bytevalue.
- Since:
- 1.8
 
- 
equalsCompares this object to the specified object. The result istrueif and only if the argument is notnulland is aByteobject that contains the samebytevalue as this object.
- 
compareToCompares twoByteobjects numerically.- Specified by:
- compareToin interface- Comparable<Byte>
- Parameters:
- anotherByte- the- Byteto be compared.
- Returns:
- the value 0if thisByteis equal to the argumentByte; a value less than0if thisByteis numerically less than the argumentByte; and a value greater than0if thisByteis numerically greater than the argumentByte(signed comparison).
- Since:
- 1.2
 
- 
comparepublic static int compare(byte x, byte y) Compares twobytevalues numerically. The value returned is identical to what would be returned by:Byte.valueOf(x).compareTo(Byte.valueOf(y))- Parameters:
- x- the first- byteto compare
- y- the second- byteto compare
- Returns:
- the value 0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y
- Since:
- 1.7
 
- 
compareUnsignedpublic static int compareUnsigned(byte x, byte y) Compares twobytevalues numerically treating the values as unsigned.- Parameters:
- x- the first- byteto compare
- y- the second- byteto compare
- Returns:
- the value 0ifx == y; a value less than0ifx < yas unsigned values; and a value greater than0ifx > yas unsigned values
- Since:
- 9
 
- 
toUnsignedIntpublic static int toUnsignedInt(byte x) Converts the argument to anintby an unsigned conversion. In an unsigned conversion to anint, the high-order 24 bits of theintare zero and the low-order 8 bits are equal to the bits of thebyteargument. Consequently, zero and positivebytevalues are mapped to a numerically equalintvalue and negativebytevalues are mapped to anintvalue equal to the input plus 28.- Parameters:
- x- the value to convert to an unsigned- int
- Returns:
- the argument converted to intby an unsigned conversion
- Since:
- 1.8
 
- 
toUnsignedLongpublic static long toUnsignedLong(byte x) Converts the argument to alongby an unsigned conversion. In an unsigned conversion to along, the high-order 56 bits of thelongare zero and the low-order 8 bits are equal to the bits of thebyteargument. Consequently, zero and positivebytevalues are mapped to a numerically equallongvalue and negativebytevalues are mapped to alongvalue equal to the input plus 28.- Parameters:
- x- the value to convert to an unsigned- long
- Returns:
- the argument converted to longby an unsigned conversion
- Since:
- 1.8
 
 
-