Package java.lang

Class Byte

All Implemented Interfaces:
Serializable, Comparable<Byte>

public final class Byte
extends Number
implements Comparable<Byte>
The wrapper for the primitive type byte.
Since:
1.1
See Also:
Serialized Form
  • Field Summary

    Fields
    Modifier and Type Field Description
    static byte MAX_VALUE
    The maximum Byte value, 27-1.
    static byte MIN_VALUE
    The minimum Byte value, -27.
    static int SIZE
    The number of bits needed to represent a Byte value in two's complement form.
    static Class<Byte> TYPE
    The Class object that represents the primitive type byte.
  • Constructor Summary

    Constructors
    Constructor Description
    Byte​(byte value)
    Constructs a new Byte with the specified primitive byte value.
    Byte​(String string)
    Constructs a new Byte from the specified string.
  • Method Summary

    Modifier and Type Method Description
    byte byteValue()
    Gets the primitive value of this byte.
    static int compare​(byte lhs, byte rhs)
    Compares two byte values.
    int compareTo​(Byte object)
    Compares this object to the specified byte object to determine their relative order.
    static Byte decode​(String string)
    Parses the specified string and returns a Byte instance if the string can be decoded into a single byte value.
    double doubleValue()
    Returns this object's value as a double.
    boolean equals​(Object object)
    Compares this object with the specified object and indicates if they are equal.
    float floatValue()
    Returns this object's value as a float.
    int hashCode()
    Returns an integer hash code for this object.
    int intValue()
    Returns this object's value as an int.
    long longValue()
    Returns this object's value as a long.
    static byte parseByte​(String string)
    Parses the specified string as a signed decimal byte value.
    static byte parseByte​(String string, int radix)
    Parses the specified string as a signed byte value using the specified radix.
    short shortValue()
    Returns this object's value as a short.
    static String toHexString​(byte b, boolean upperCase)
    Returns a two-digit hex string.
    String toString()
    Returns a string containing a concise, human-readable description of this object.
    static String toString​(byte value)
    Returns a string containing a concise, human-readable description of the specified byte value.
    static Byte valueOf​(byte b)
    Returns a Byte instance for the specified byte value.
    static Byte valueOf​(String string)
    Parses the specified string as a signed decimal byte value.
    static Byte valueOf​(String string, int radix)
    Parses the specified string as a signed byte value using the specified radix.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • MAX_VALUE

      public static final byte MAX_VALUE
      The maximum Byte value, 27-1.
      See Also:
      Constant Field Values
    • MIN_VALUE

      public static final byte MIN_VALUE
      The minimum Byte value, -27.
      See Also:
      Constant Field Values
    • SIZE

      public static final int SIZE
      The number of bits needed to represent a Byte value in two's complement form.
      Since:
      1.5
      See Also:
      Constant Field Values
    • TYPE

      public static final Class<Byte> TYPE
      The Class object that represents the primitive type byte.
  • Constructor Details

    • Byte

      public Byte​(byte value)
      Constructs a new Byte with the specified primitive byte value.
      Parameters:
      value - the primitive byte value to store in the new instance.
    • Byte

      public Byte​(String string) throws NumberFormatException
      Constructs a new Byte from the specified string.
      Parameters:
      string - the string representation of a single byte value.
      Throws:
      NumberFormatException - if string cannot be parsed as a byte value.
      See Also:
      parseByte(String)
  • Method Details

    • byteValue

      public byte byteValue()
      Gets the primitive value of this byte.
      Overrides:
      byteValue in class Number
      Returns:
      this object's primitive value.
    • compareTo

      public int compareTo​(Byte object)
      Compares this object to the specified byte object to determine their relative order.
      Specified by:
      compareTo in interface Comparable<Byte>
      Parameters:
      object - the byte object to compare this object to.
      Returns:
      a negative value if the value of this byte is less than the value of object; 0 if the value of this byte and the value of object are equal; a positive value if the value of this byte is greater than the value of object.
      Since:
      1.2
      See Also:
      Comparable
    • compare

      public static int compare​(byte lhs, byte rhs)
      Compares two byte values.
      Returns:
      0 if lhs = rhs, less than 0 if lhs < rhs, and greater than 0 if lhs > rhs.
      Since:
      1.7
    • decode

      public static Byte decode​(String string) throws NumberFormatException
      Parses the specified string and returns a Byte instance if the string can be decoded into a single byte value. The string may be an optional minus sign "-" followed by a hexadecimal ("0x..." or "#..."), octal ("0..."), or decimal ("...") representation of a byte.
      Parameters:
      string - a string representation of a single byte value.
      Returns:
      a Byte containing the value represented by string.
      Throws:
      NumberFormatException - if string cannot be parsed as a byte value.
    • doubleValue

      public double doubleValue()
      Description copied from class: Number
      Returns this object's value as a double. Might involve rounding.
      Specified by:
      doubleValue in class Number
      Returns:
      the primitive double value of this object.
    • equals

      public boolean equals​(Object object)
      Compares this object with the specified object and indicates if they are equal. In order to be equal, object must be an instance of Byte and have the same byte value as this object.
      Overrides:
      equals in class Object
      Parameters:
      object - the object to compare this byte with.
      Returns:
      true if the specified object is equal to this Byte; false otherwise.
      See Also:
      Object.hashCode()
    • floatValue

      public float floatValue()
      Description copied from class: Number
      Returns this object's value as a float. Might involve rounding.
      Specified by:
      floatValue in class Number
      Returns:
      the primitive float value of this object.
    • hashCode

      public int hashCode()
      Description copied from class: Object
      Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

      Note that hash values must not change over time unless information used in equals comparisons also changes.

      See Writing a correct hashCode method if you intend implementing your own hashCode method.

      Overrides:
      hashCode in class Object
      Returns:
      this object's hash code.
      See Also:
      Object.equals(java.lang.Object)
    • intValue

      public int intValue()
      Description copied from class: Number
      Returns this object's value as an int. Might involve rounding and/or truncating the value, so it fits into an int.
      Specified by:
      intValue in class Number
      Returns:
      the primitive int value of this object.
    • longValue

      public long longValue()
      Description copied from class: Number
      Returns this object's value as a long. Might involve rounding and/or truncating the value, so it fits into a long.
      Specified by:
      longValue in class Number
      Returns:
      the primitive long value of this object.
    • parseByte

      public static byte parseByte​(String string) throws NumberFormatException
      Parses the specified string as a signed decimal byte value. The ASCII character - ('-') is recognized as the minus sign.
      Parameters:
      string - the string representation of a single byte value.
      Returns:
      the primitive byte value represented by string.
      Throws:
      NumberFormatException - if string can not be parsed as a byte value.
    • parseByte

      public static byte parseByte​(String string, int radix) throws NumberFormatException
      Parses the specified string as a signed byte value using the specified radix. The ASCII character - ('-') is recognized as the minus sign.
      Parameters:
      string - the string representation of a single byte value.
      radix - the radix to use when parsing.
      Returns:
      the primitive byte value represented by string using radix.
      Throws:
      NumberFormatException - if string can not be parsed as a byte value, or radix < Character.MIN_RADIX || radix > Character.MAX_RADIX.
    • shortValue

      public short shortValue()
      Description copied from class: Number
      Returns this object's value as a short. Might involve rounding and/or truncating the value, so it fits into a short.
      Overrides:
      shortValue in class Number
      Returns:
      the primitive short value of this object.
    • toString

      public String toString()
      Description copied from class: Object
      Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
         getClass().getName() + '@' + Integer.toHexString(hashCode())

      See Writing a useful toString method if you intend implementing your own toString method.

      Overrides:
      toString in class Object
      Returns:
      a printable representation of this object.
    • toHexString

      public static String toHexString​(byte b, boolean upperCase)
      Returns a two-digit hex string. That is, -1 becomes "ff" or "FF" and 2 becomes "02".
    • toString

      public static String toString​(byte value)
      Returns a string containing a concise, human-readable description of the specified byte value.
      Parameters:
      value - the byte to convert to a string.
      Returns:
      a printable representation of value.
    • valueOf

      public static Byte valueOf​(String string) throws NumberFormatException
      Parses the specified string as a signed decimal byte value.
      Parameters:
      string - the string representation of a single byte value.
      Returns:
      a Byte instance containing the byte value represented by string.
      Throws:
      NumberFormatException - if string can not be parsed as a byte value.
      See Also:
      parseByte(String)
    • valueOf

      public static Byte valueOf​(String string, int radix) throws NumberFormatException
      Parses the specified string as a signed byte value using the specified radix.
      Parameters:
      string - the string representation of a single byte value.
      radix - the radix to use when parsing.
      Returns:
      a Byte instance containing the byte value represented by string using radix.
      Throws:
      NumberFormatException - if string can not be parsed as a byte value, or radix < Character.MIN_RADIX || radix > Character.MAX_RADIX.
      See Also:
      parseByte(String, int)
    • valueOf

      public static Byte valueOf​(byte b)
      Returns a Byte instance for the specified byte value.

      If it is not necessary to get a new Byte instance, it is recommended to use this method instead of the constructor, since it maintains a cache of instances which may result in better performance.

      Parameters:
      b - the byte value to store in the instance.
      Returns:
      a Byte instance containing b.
      Since:
      1.5