Byte
class Byte : Number, Comparable<Byte!>
kotlin.Any | ||
↳ | kotlin.Number | |
↳ | java.lang.Byte |
The 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
.
Summary
Constants | |
---|---|
static Int |
The number of bytes used to represent a |
static Byte |
A constant holding the maximum value a |
static Byte |
A constant holding the minimum value a |
static Int |
The number of bits used to represent a |
Public constructors | |
---|---|
Constructs a newly allocated |
|
Constructs a newly allocated |
Public methods | |
---|---|
static Int |
Compares two |
Int |
Compares two |
static Int |
compareUnsigned(x: Byte, y: Byte) Compares two |
static Byte |
Decodes a |
Boolean |
Compares this object to the specified object. |
Int |
hashCode() Returns a hash code for this |
static Int |
Returns a hash code for a |
static Byte |
Parses the string argument as a signed |
static Byte |
Parses the string argument as a signed decimal |
Byte |
toByte() Returns the value of this |
Double |
toDouble() Returns the value of this |
Float |
toFloat() Returns the value of this |
Int |
toInt() Returns the value of this |
Long |
toLong() Returns the value of this |
Short |
toShort() Returns the value of this |
String |
toString() Returns a |
static String |
Returns a new |
static Int |
toUnsignedInt(x: Byte) Converts the argument to an |
static Long |
toUnsignedLong(x: Byte) Converts the argument to a |
static Byte |
Returns a |
static Byte |
Returns a |
static Byte |
Returns a |
Properties | |
---|---|
static Class<Byte!>! |
The |
Constants
BYTES
static val BYTES: Int
The number of bytes used to represent a byte
value in two's complement binary form.
Value: 1
MAX_VALUE
static val MAX_VALUE: Byte
A constant holding the maximum value a byte
can have, 27-1.
Value: 127
MIN_VALUE
static val MIN_VALUE: Byte
A constant holding the minimum value a byte
can have, -27.
Value: -128
SIZE
static val SIZE: Int
The number of bits used to represent a byte
value in two's complement binary form.
Value: 8
Public constructors
Byte
Byte(value: Byte)
Deprecated: 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 . |
Byte
Byte(s: String)
Deprecated: It is rarely appropriate to use this constructor. Use parseByte(java.lang.String)
to convert a string to a byte
primitive, or use valueOf(java.lang.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 |
Exceptions | |
---|---|
java.lang.NumberFormatException |
if the String does not contain a parsable byte . |
Public methods
compare
static fun compare(
x: Byte,
y: Byte
): Int
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 |
Return | |
---|---|
Int |
the value 0 if x == y ; a value less than 0 if x < y ; and a value greater than 0 if x > y |
compareTo
fun compareTo(other: Byte): Int
Compares two Byte
objects numerically.
Parameters | |
---|---|
o |
the object to be compared. |
anotherByte |
the Byte to be compared. |
Return | |
---|---|
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). |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
compareUnsigned
static fun compareUnsigned(
x: Byte,
y: Byte
): Int
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 |
Return | |
---|---|
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 |
decode
static fun decode(nm: String): Byte
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:
-
+
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. |
Return | |
---|---|
Byte |
a Byte object holding the byte value represented by nm |
Exceptions | |
---|---|
java.lang.NumberFormatException |
if the String does not contain a parsable byte . |
equals
fun equals(other: Any?): Boolean
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 |
the object to compare with |
Return | |
---|---|
Boolean |
true if the objects are the same; false otherwise. |
hashCode
fun hashCode(): Int
Returns a hash code for this Byte
; equal to the result of invoking intValue()
.
Return | |
---|---|
Int |
a hash code value for this Byte |
hashCode
static fun hashCode(value: Byte): Int
Returns a hash code for a byte
value; compatible with Byte.hashCode()
.
Parameters | |
---|---|
value |
Byte: the value to hash |
Return | |
---|---|
Int |
a hash code value for a byte value. |
parseByte
static fun parseByte(
s: String,
radix: Int
): Byte
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 '-'
('\u005Cu002D'
) to indicate a negative value or an ASCII plus sign '+'
('\u005Cu002B'
) 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 thanjava.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
'-'
('\u005Cu002D'
) or plus sign'+'
('\u005Cu002B'
) 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 |
Return | |
---|---|
Byte |
the byte value represented by the string argument in the specified radix |
Exceptions | |
---|---|
java.lang.NumberFormatException |
If the string does not contain a parsable byte . |
parseByte
static fun parseByte(s: String): Byte
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 '-'
('\u005Cu002D'
) to indicate a negative value or an ASCII plus sign '+'
('\u005Cu002B'
) 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 |
Return | |
---|---|
Byte |
the byte value represented by the argument in decimal |
Exceptions | |
---|---|
java.lang.NumberFormatException |
if the string does not contain a parsable byte . |
toByte
fun toByte(): Byte
Returns the value of this Byte
as a byte
.
Return | |
---|---|
Byte |
the numeric value represented by this object after conversion to type byte . |
toDouble
fun toDouble(): Double
Returns the value of this Byte
as a double
after a widening primitive conversion.
Return | |
---|---|
Double |
the numeric value represented by this object after conversion to type double . |
toFloat
fun toFloat(): Float
Returns the value of this Byte
as a float
after a widening primitive conversion.
Return | |
---|---|
Float |
the numeric value represented by this object after conversion to type float . |
toInt
fun toInt(): Int
Returns the value of this Byte
as an int
after a widening primitive conversion.
Return | |
---|---|
Int |
the numeric value represented by this object after conversion to type int . |
toLong
fun toLong(): Long
Returns the value of this Byte
as a long
after a widening primitive conversion.
Return | |
---|---|
Long |
the numeric value represented by this object after conversion to type long . |
toShort
fun toShort(): Short
Returns the value of this Byte
as a short
after a widening primitive conversion.
Return | |
---|---|
Short |
the numeric value represented by this object after conversion to type short . |
toString
fun toString(): String
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.
Return | |
---|---|
String |
a string representation of the value of this object in base 10. |
toString
static fun toString(b: Byte): String
Returns a new String
object representing the specified byte
. The radix is assumed to be 10.
Parameters | |
---|---|
b |
Byte: the byte to be converted |
Return | |
---|---|
String |
the string representation of the specified byte |
See Also
toUnsignedInt
static fun toUnsignedInt(x: Byte): Int
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 |
Return | |
---|---|
Int |
the argument converted to int by an unsigned conversion |
toUnsignedLong
static fun toUnsignedLong(x: Byte): Long
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 |
Return | |
---|---|
Long |
the argument converted to long by an unsigned conversion |
valueOf
static fun valueOf(b: Byte): Byte
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. |
Return | |
---|---|
Byte |
a Byte instance representing b . |
valueOf
static fun valueOf(
s: String,
radix: Int
): Byte
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:
new Byte(Byte.parseByte(s, radix))
Parameters | |
---|---|
s |
String: the string to be parsed |
radix |
Int: the radix to be used in interpreting s |
Return | |
---|---|
Byte |
a Byte object holding the value represented by the string argument in the specified radix. |
Exceptions | |
---|---|
java.lang.NumberFormatException |
If the String does not contain a parsable byte . |
valueOf
static fun valueOf(s: String): Byte
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:
new Byte(Byte.parseByte(s))
Parameters | |
---|---|
s |
String: the string to be parsed |
Return | |
---|---|
Byte |
a Byte object holding the value represented by the string argument |
Exceptions | |
---|---|
java.lang.NumberFormatException |
If the String does not contain a parsable byte . |
Properties
TYPE
static val TYPE: Class<Byte!>!
The Class
instance representing the primitive type byte
.