Short
class Short : Number, Comparable<Short!>
| kotlin.Any | ||
| ↳ | kotlin.Number | |
| ↳ | java.lang.Short | |
The Short class wraps a value of primitive type short in an object. An object of type Short contains a single field whose type is short.
In addition, this class provides several methods for converting a short to a String and a String to a short, as well as other constants and methods useful when dealing with a short.
Summary
| Constants | |
|---|---|
| static Int |
The number of bytes used to represent a |
| static Short |
A constant holding the maximum value a |
| static Short |
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: Short, y: Short)Compares two |
| static Short! |
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 Short |
parseShort(s: String!)Parses the string argument as a signed decimal |
| static Short |
parseShort(s: String!, radix: Int)Parses the string argument as a signed |
| static Short |
reverseBytes(i: Short)Returns the value obtained by reversing the order of the bytes in the two's complement representation of the specified |
| 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: Short)Converts the argument to an |
| static Long |
toUnsignedLong(x: Short)Converts the argument to a |
| static Short! |
Returns a |
| static Short! |
Returns a |
| static Short! |
Returns a |
| Properties | |
|---|---|
| static Class<Short!>! |
The |
Constants
BYTES
static val BYTES: Int
The number of bytes used to represent a short value in two's complement binary form.
Value: 2MAX_VALUE
static val MAX_VALUE: Short
A constant holding the maximum value a short can have, 215-1.
Value: 32767MIN_VALUE
static val MIN_VALUE: Short
A constant holding the minimum value a short can have, -215.
Value: -32768SIZE
static val SIZE: Int
The number of bits used to represent a short value in two's complement binary form.
Value: 16Public constructors
Short
Short(s: String!)
Deprecated: It is rarely appropriate to use this constructor. Use parseShort(java.lang.String) to convert a string to a short primitive, or use valueOf(java.lang.String) to convert a string to a Short object.
Constructs a newly allocated Short object that represents the short value indicated by the String parameter. The string is converted to a short value in exactly the manner used by the parseShort method for radix 10.
| Parameters | |
|---|---|
s |
String!: the String to be converted to a Short |
| Exceptions | |
|---|---|
java.lang.NumberFormatException |
If the String does not contain a parsable short. |
Short
Short(value: Short)
Deprecated: It is rarely appropriate to use this constructor. The static factory valueOf(short) is generally a better choice, as it is likely to yield significantly better space and time performance.
Constructs a newly allocated Short object that represents the specified short value.
| Parameters | |
|---|---|
value |
Short: the value to be represented by the Short. |
Public methods
compare
static fun compare(
x: Short,
y: Short
): Int
Compares two short values numerically. The value returned is identical to what would be returned by:
Short.valueOf(x).compareTo(Short.valueOf(y))
| Parameters | |
|---|---|
x |
Short: the first short to compare |
y |
Short: the second short 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: Short!): Int
Compares two Short objects numerically.
| Parameters | |
|---|---|
o |
the object to be compared. |
anotherShort |
the Short to be compared. |
| Return | |
|---|---|
Int |
the value 0 if this Short is equal to the argument Short; a value less than 0 if this Short is numerically less than the argument Short; and a value greater than 0 if this Short is numerically greater than the argument Short (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: Short,
y: Short
): Int
Compares two short values numerically treating the values as unsigned.
| Parameters | |
|---|---|
x |
Short: the first short to compare |
y |
Short: the second short 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!): Short!
Decodes a String into a Short. Accepts decimal, hexadecimal, and octal numbers given by the following grammar:
- DecodableString:
- Signopt DecimalNumeral
- Signopt
0xHexDigits - Signopt
0XHexDigits - Signopt
HexDigits - Signopt
0OctalDigits - Sign:
-+
The sequence of characters following an optional sign and/or radix specifier ("0x", "0X", "", or leading zero) is parsed as by the Short.parseShort 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 | |
|---|---|
Short! |
a Short object holding the short value represented by nm |
| Exceptions | |
|---|---|
java.lang.NumberFormatException |
if the String does not contain a parsable short. |
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 Short object that contains the same short 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 Short; equal to the result of invoking intValue().
| Return | |
|---|---|
Int |
a hash code value for this Short |
hashCode
static fun hashCode(value: Short): Int
Returns a hash code for a short value; compatible with Short.hashCode().
| Parameters | |
|---|---|
value |
Short: the value to hash |
| Return | |
|---|---|
Int |
a hash code value for a short value. |
parseShort
static fun parseShort(s: String!): Short
Parses the string argument as a signed decimal short. 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 short value is returned, exactly as if the argument and the radix 10 were given as arguments to the parseShort(java.lang.String,int) method.
| Parameters | |
|---|---|
s |
String!: a String containing the short representation to be parsed |
| Return | |
|---|---|
Short |
the short value represented by the argument in decimal. |
| Exceptions | |
|---|---|
java.lang.NumberFormatException |
If the string does not contain a parsable short. |
parseShort
static fun parseShort(
s: String!,
radix: Int
): Short
Parses the string argument as a signed short 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 short value is returned.
An exception of type NumberFormatException is 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
java.lang.Character#MIN_RADIXor 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
short.
| Parameters | |
|---|---|
s |
String!: the String containing the short representation to be parsed |
radix |
Int: the radix to be used while parsing s |
| Return | |
|---|---|
Short |
the short represented by the string argument in the specified radix. |
| Exceptions | |
|---|---|
java.lang.NumberFormatException |
If the String does not contain a parsable short. |
reverseBytes
static fun reverseBytes(i: Short): Short
Returns the value obtained by reversing the order of the bytes in the two's complement representation of the specified short value.
| Parameters | |
|---|---|
i |
Short: the value whose bytes are to be reversed |
| Return | |
|---|---|
Short |
the value obtained by reversing (or, equivalently, swapping) the bytes in the specified short value. |
toByte
fun toByte(): Byte
Returns the value of this Short as a byte after a narrowing primitive conversion.
| Return | |
|---|---|
Byte |
the numeric value represented by this object after conversion to type byte. |
toDouble
fun toDouble(): Double
Returns the value of this Short 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 Short 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 Short 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 Short 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 Short as a short.
| Return | |
|---|---|
Short |
the numeric value represented by this object after conversion to type short. |
toString
fun toString(): String
Returns a String object representing this Short's value. The value is converted to signed decimal representation and returned as a string, exactly as if the short value were given as an argument to the java.lang.Short#toString(short) method.
| Return | |
|---|---|
String |
a string representation of the value of this object in base 10. |
toString
static fun toString(s: Short): String!
Returns a new String object representing the specified short. The radix is assumed to be 10.
| Parameters | |
|---|---|
s |
Short: the short to be converted |
| Return | |
|---|---|
String! |
the string representation of the specified short |
See Also
toUnsignedInt
static fun toUnsignedInt(x: Short): Int
Converts the argument to an int by an unsigned conversion. In an unsigned conversion to an int, the high-order 16 bits of the int are zero and the low-order 16 bits are equal to the bits of the short argument. Consequently, zero and positive short values are mapped to a numerically equal int value and negative short values are mapped to an int value equal to the input plus 216.
| Parameters | |
|---|---|
x |
Short: the value to convert to an unsigned int |
| Return | |
|---|---|
Int |
the argument converted to int by an unsigned conversion |
toUnsignedLong
static fun toUnsignedLong(x: Short): Long
Converts the argument to a long by an unsigned conversion. In an unsigned conversion to a long, the high-order 48 bits of the long are zero and the low-order 16 bits are equal to the bits of the short argument. Consequently, zero and positive short values are mapped to a numerically equal long value and negative short values are mapped to a long value equal to the input plus 216.
| Parameters | |
|---|---|
x |
Short: the value to convert to an unsigned long |
| Return | |
|---|---|
Long |
the argument converted to long by an unsigned conversion |
valueOf
static fun valueOf(s: String!): Short!
Returns a Short object holding the value given by the specified String. The argument is interpreted as representing a signed decimal short, exactly as if the argument were given to the parseShort(java.lang.String) method. The result is a Short object that represents the short value specified by the string.
In other words, this method returns a Short object equal to the value of:
new Short(Short.parseShort(s))
| Parameters | |
|---|---|
s |
String!: the string to be parsed |
| Return | |
|---|---|
Short! |
a Short object holding the value represented by the string argument |
| Exceptions | |
|---|---|
java.lang.NumberFormatException |
If the String does not contain a parsable short. |
valueOf
static fun valueOf(
s: String!,
radix: Int
): Short!
Returns a Short 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 short in the radix specified by the second argument, exactly as if the argument were given to the parseShort(java.lang.String,int) method. The result is a Short object that represents the short value specified by the string.
In other words, this method returns a Short object equal to the value of:
new Short(Short.parseShort(s, radix))
| Parameters | |
|---|---|
s |
String!: the string to be parsed |
radix |
Int: the radix to be used in interpreting s |
| Return | |
|---|---|
Short! |
a Short 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 short. |
valueOf
static fun valueOf(s: Short): Short!
Returns a Short instance representing the specified short value. If a new Short instance is not required, this method should generally be used in preference to the constructor Short(short), as this method is likely to yield significantly better space and time performance by caching frequently requested values. This method will always cache values in the range -128 to 127, inclusive, and may cache other values outside of this range.
| Parameters | |
|---|---|
s |
Short: a short value. |
| Return | |
|---|---|
Short! |
a Short instance representing s. |
Properties
TYPE
static val TYPE: Class<Short!>!
The Class instance representing the primitive type short.