Class Byte

java.lang.Object
java.lang.Number
java.lang.Byte
All Implemented Interfaces:
Serializable,Comparable<Byte>,Constable

public final classByteextendsNumberimplementsComparable<Byte>,Constable
TheByte class is thewrapper class for values of the primitivetypebyte. An object of typeByte contains asingle field whose type isbyte.

In addition, this class provides several methods for convertingabyte to aString and aString to abyte, as well as other constants and methods useful when dealingwith abyte.

This is avalue-basedclass; programmers should treat instances that areequal as interchangeable and should notuse instances for synchronization, or unpredictable behavior mayoccur. For example, in a future release, synchronization may fail.

Since:
1.1
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The number of bytes used to represent abyte value in two'scomplement binary form.
    static final byte
    A constant holding the maximum value abyte canhave, 27-1.
    static final byte
    A constant holding the minimum value abyte canhave, -27.
    static final int
    The number of bits used to represent abyte value in two'scomplement binary form.
    static finalClass<Byte>
    TheClass instance representing the primitive typebyte.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Byte(byte value)
    Deprecated.
    It is rarely appropriate to use this constructor.
    Deprecated.
    It is rarely appropriate to use this constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    byte
    Returns the value of thisByte as abyte.
    static int
    compare(byte x, byte y)
    Compares twobyte values numerically.
    int
    compareTo(Byte anotherByte)
    Compares twoByte objects numerically.
    static int
    compareUnsigned(byte x, byte y)
    Compares twobyte values numerically treating the valuesas unsigned.
    staticByte
    Decodes aString into aByte.
    Returns anOptional containing the nominal descriptor for thisinstance.
    double
    Returns the value of thisByte as adoubleafter a widening primitive conversion.
    boolean
    Compares this object to the specified object.
    float
    Returns the value of thisByte as afloat aftera widening primitive conversion.
    int
    Returns a hash code for thisByte; equal to the resultof invokingintValue().
    static int
    hashCode(byte value)
    Returns a hash code for abyte value; compatible withByte.hashCode().
    int
    Returns the value of thisByte as anint aftera widening primitive conversion.
    long
    Returns the value of thisByte as along aftera widening primitive conversion.
    static byte
    Parses the string argument as a signed decimalbyte.
    static byte
    parseByte(String s, int radix)
    Parses the string argument as a signedbyte in theradix specified by the second argument.
    short
    Returns the value of thisByte as ashort aftera widening primitive conversion.
    Returns aString object representing thisByte's value.
    staticString
    toString(byte b)
    Returns a newString object representing thespecifiedbyte.
    static int
    toUnsignedInt(byte x)
    Converts the argument to anint by an unsignedconversion.
    static long
    Converts the argument to along by an unsignedconversion.
    staticByte
    valueOf(byte b)
    Returns aByte instance representing the specifiedbyte value.
    staticByte
    Returns aByte object holding the valuegiven by the specifiedString.
    staticByte
    valueOf(String s, int radix)
    Returns aByte object holding the valueextracted from the specifiedString when parsedwith the radix given by the second argument.
  • Field Details

    • MIN_VALUE

      public static final byte MIN_VALUE
      A constant holding the minimum value abyte canhave, -27.
      See Also:
    • MAX_VALUE

      public static final byte MAX_VALUE
      A constant holding the maximum value abyte canhave, 27-1.
      See Also:
    • TYPE

      public static final Class<Byte> TYPE
      TheClass instance representing the primitive typebyte.
    • SIZE

      public static final int SIZE
      The number of bits used to represent abyte value in two'scomplement binary form.
      Since:
      1.5
      See Also:
    • BYTES

      public static final int BYTES
      The number of bytes used to represent abyte value in two'scomplement binary form.
      Since:
      1.8
      See Also:
  • Constructor Details

    • Byte

      @Deprecated(since="9")public Byte(byte value)
      Deprecated.
      It is rarely appropriate to use this constructor. The static factoryvalueOf(byte) is generally a better choice, as it islikely to yield significantly better space and time performance.
      Constructs a newly allocatedByte object thatrepresents the specifiedbyte value.
      Parameters:
      value - the value to be represented by theByte.
    • Byte

      @Deprecated(since="9")public Byte(String s) throwsNumberFormatException
      Deprecated.
      It is rarely appropriate to use this constructor.UseparseByte(String) to convert a string to abyte primitive, or usevalueOf(String)to convert a string to aByte object.
      Constructs a newly allocatedByte object thatrepresents thebyte value indicated by theString parameter. The string is converted to abyte value in exactly the manner used by theparseByte method for radix 10.
      Parameters:
      s - theString to be converted to aByte
      Throws:
      NumberFormatException - if theString does not contain a parsablebyte.
  • Method Details

    • toString

      public static String toString(byte b)
      Returns a newString object representing thespecifiedbyte. The radix is assumed to be 10.
      Parameters:
      b - thebyte to be converted
      Returns:
      the string representation of the specifiedbyte
      See Also:
    • describeConstable

      public Optional<DynamicConstantDesc<Byte>> describeConstable()
      Returns anOptional containing the nominal descriptor for thisinstance.
      Specified by:
      describeConstable in interface Constable
      Returns:
      anOptional describing theByte instance
      Since:
      15
    • valueOf

      public static Byte valueOf(byte b)
      Returns aByte instance representing the specifiedbyte value.If a newByte instance is not required, this methodshould generally be used in preference to the constructorByte(byte), as this method is likely to yieldsignificantly better space and time performance sinceall byte values are cached.
      Parameters:
      b - a byte value.
      Returns:
      aByte instance representingb.
      Since:
      1.5
    • parseByte

      public static byte parseByte(String s, int radix) throwsNumberFormatException
      Parses the string argument as a signedbyte in theradix specified by the second argument. The characters in thestring must all be digits, of the specified radix (asdetermined by whetherCharacter.digit(char, int) returns a nonnegative value) except that the firstcharacter may be an ASCII minus sign'-'('\u002D') to indicate a negative value or anASCII plus sign'+' ('\u002B') toindicate a positive value. The resultingbyte value isreturned.

      An exception of typeNumberFormatException isthrown if any of the following situations occurs:

      • The first argument isnull or is a string oflength zero.
      • The radix is either smaller thanCharacter.MIN_RADIX or larger thanCharacter.MAX_RADIX.
      • Any character of the string is not a digit of thespecified radix, except that the first character may be a minussign'-' ('\u002D') or plus sign'+' ('\u002B') provided that thestring is longer than length 1.
      • The value represented by the string is not a value of typebyte.

      Parameters:
      s - theString containing thebyte representation to be parsed
      radix - the radix to be used while parsings
      Returns:
      thebyte value represented by the string argument in the specified radix
      Throws:
      NumberFormatException - If the string does not contain a parsablebyte.
    • parseByte

      public static byte parseByte(String s) throwsNumberFormatException
      Parses 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 negativevalue or an ASCII plus sign'+'('\u002B') to indicate a positive value. Theresultingbyte value is returned, exactly as if theargument and the radix 10 were given as arguments to theparseByte(java.lang.String, int) method.
      Parameters:
      s - aString containing thebyte representation to be parsed
      Returns:
      thebyte value represented by the argument in decimal
      Throws:
      NumberFormatException - if the string does not contain a parsablebyte.
    • valueOf

      public static Byte valueOf(String s, int radix) throwsNumberFormatException
      Returns aByte object holding the valueextracted from the specifiedString when parsedwith the radix given by the second argument. The first argumentis interpreted as representing a signedbyte inthe radix specified by the second argument, exactly as if theargument were given to theparseByte(java.lang.String, int) method. The result is aByte object thatrepresents thebyte value specified by the string.

      In other words, this method returns aByte objectequal to the value of:

      Byte.valueOf(Byte.parseByte(s, radix))

      Parameters:
      s - the string to be parsed
      radix - the radix to be used in interpretings
      Returns:
      aByte object holding the value represented by the string argument in the specified radix.
      Throws:
      NumberFormatException - If theString does not contain a parsablebyte.
    • valueOf

      public static Byte valueOf(String s) throwsNumberFormatException
      Returns aByte object holding the valuegiven by the specifiedString. The argument isinterpreted as representing a signed decimalbyte,exactly as if the argument were given to theparseByte(java.lang.String) method. The result is aByte object that represents thebytevalue specified by the string.

      In other words, this method returns aByte objectequal to the value of:

      Byte.valueOf(Byte.parseByte(s))

      Parameters:
      s - the string to be parsed
      Returns:
      aByte object holding the value represented by the string argument
      Throws:
      NumberFormatException - If theString does not contain a parsablebyte.
    • decode

      public static Byte decode(String nm) throwsNumberFormatException
      Decodes aString into aByte.Accepts decimal, hexadecimal, and octal numbers given bythe following grammar:
      DecodableString:
      Signopt DecimalNumeral
      Signopt0xHexDigits
      Signopt0XHexDigits
      Signopt#HexDigits
      Signopt0OctalDigits
      Sign:
      -
      +
      DecimalNumeral,HexDigits, andOctalDigitsare as defined in section3.10.1 ofThe Java Language Specification,except that underscores are not accepted between digits.

      The sequence of characters following an optionalsign and/or radix specifier ("0x", "0X","#", or leading zero) is parsed as by theByte.parseByte method with the indicated radix (10, 16, or 8).This sequence of characters must represent a positive value oraNumberFormatException will be thrown. The result isnegated if first character of the specifiedString isthe minus sign. No whitespace characters are permitted in theString.

      Parameters:
      nm - theString to decode.
      Returns:
      aByte object holding thebyte value represented bynm
      Throws:
      NumberFormatException - if theString does not contain a parsablebyte.
      See Also:
    • byteValue

      public byte byteValue()
      Returns the value of thisByte as abyte.
      Overrides:
      byteValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typebyte.
    • shortValue

      public short shortValue()
      Returns the value of thisByte as ashort aftera widening primitive conversion.
      Overrides:
      shortValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typeshort.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • intValue

      public int intValue()
      Returns the value of thisByte as anint aftera widening primitive conversion.
      Specified by:
      intValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typeint.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • longValue

      public long longValue()
      Returns the value of thisByte as along aftera widening primitive conversion.
      Specified by:
      longValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typelong.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • floatValue

      public float floatValue()
      Returns the value of thisByte as afloat aftera widening primitive conversion.
      Specified by:
      floatValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typefloat.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • doubleValue

      public double doubleValue()
      Returns the value of thisByte as adoubleafter a widening primitive conversion.
      Specified by:
      doubleValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typedouble.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • toString

      public String toString()
      Returns aString object representing thisByte's value. The value is converted to signeddecimal representation and returned as a string, exactly as ifthebyte value were given as an argument to thetoString(byte) method.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the value of this object in base 10.
    • hashCode

      public int hashCode()
      Returns a hash code for thisByte; equal to the resultof invokingintValue().
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for thisByte
      See Also:
    • hashCode

      public static int hashCode(byte value)
      Returns a hash code for abyte value; compatible withByte.hashCode().
      Parameters:
      value - the value to hash
      Returns:
      a hash code value for abyte value.
      Since:
      1.8
    • equals

      public boolean equals(Object obj)
      Compares this object to the specified object. The result istrue if and only if the argument is notnull and is aByte object thatcontains the samebyte value as this object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare with
      Returns:
      true if the objects are the same;false otherwise.
      See Also:
    • compareTo

      public int compareTo(Byte anotherByte)
      Compares twoByte objects numerically.
      Specified by:
      compareTo in interface Comparable<Byte>
      Parameters:
      anotherByte - theByte to be compared.
      Returns:
      the value0 if thisByte is equal to the argumentByte; a value less than0 if thisByte is numerically less than the argumentByte; and a value greater than0 if thisByte is numerically greater than the argumentByte (signed comparison).
      Since:
      1.2
    • compare

      public static int compare(byte x, byte y)
      Compares twobyte values numerically.The value returned is identical to what would be returned by:
         Byte.valueOf(x).compareTo(Byte.valueOf(y))
      Parameters:
      x - the firstbyte to compare
      y - the secondbyte to compare
      Returns:
      the value0 ifx == y; a value less than0 ifx < y; and a value greater than0 ifx > y
      Since:
      1.7
    • compareUnsigned

      public static int compareUnsigned(byte x, byte y)
      Compares twobyte values numerically treating the valuesas unsigned.
      Parameters:
      x - the firstbyte to compare
      y - the secondbyte to compare
      Returns:
      the value0 ifx == y; a value less than0 ifx < y as unsigned values; and a value greater than0 ifx > y as unsigned values
      Since:
      9
    • toUnsignedInt

      public static int toUnsignedInt(byte x)
      Converts the argument to anint by an unsignedconversion. In an unsigned conversion to anint, thehigh-order 24 bits of theint are zero and thelow-order 8 bits are equal to the bits of thebyte argument.Consequently, zero and positivebyte values are mappedto a numerically equalint value and negativebyte values are mapped to anint value equal to theinput plus 28.
      Parameters:
      x - the value to convert to an unsignedint
      Returns:
      the argument converted toint by an unsigned conversion
      Since:
      1.8
    • toUnsignedLong

      public static long toUnsignedLong(byte x)
      Converts the argument to along by an unsignedconversion. In an unsigned conversion to along, thehigh-order 56 bits of thelong are zero and thelow-order 8 bits are equal to the bits of thebyte argument.Consequently, zero and positivebyte values are mappedto a numerically equallong value and negativebyte values are mapped to along value equal to theinput plus 28.
      Parameters:
      x - the value to convert to an unsignedlong
      Returns:
      the argument converted tolong by an unsigned conversion
      Since:
      1.8