Short

public final class Short
extends Number implements Comparable<Short>

java.lang.Object
   ↳ java.lang.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.

See also:

Summary

Constants

int BYTES

The number of bytes used to represent a short value in two's complement binary form.

short MAX_VALUE

A constant holding the maximum value a short can have, 215-1.

short MIN_VALUE

A constant holding the minimum value a short can have, -215.

int SIZE

The number of bits used to represent a short value in two's complement binary form.

Fields

public static final Class<Short> TYPE

The Class instance representing the primitive type short.

Public constructors

Short(String s)

This constructor is 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.

Short(short value)

This constructor is 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.

Public methods

byte byteValue()

Returns the value of this Short as a byte after a narrowing primitive conversion.

static int compare(short x, short y)

Compares two short values numerically.

int compareTo(Short anotherShort)

Compares two Short objects numerically.

static int compareUnsigned(short x, short y)

Compares two short values numerically treating the values as unsigned.

static Short decode(String nm)

Decodes a String into a Short.

double doubleValue()

Returns the value of this Short as a double after a widening primitive conversion.

boolean equals(Object obj)

Compares this object to the specified object.

float floatValue()

Returns the value of this Short as a float after a widening primitive conversion.

static int hashCode(short value)

Returns a hash code for a short value; compatible with Short.hashCode().

int hashCode()

Returns a hash code for this Short; equal to the result of invoking intValue().

int intValue()

Returns the value of this Short as an int after a widening primitive conversion.

long longValue()

Returns the value of this Short as a long after a widening primitive conversion.

static short parseShort(String s)

Parses the string argument as a signed decimal short.

static short parseShort(String s, int radix)

Parses the string argument as a signed short in the radix specified by the second argument.

static short reverseBytes(short i)

Returns the value obtained by reversing the order of the bytes in the two's complement representation of the specified short value.

short shortValue()

Returns the value of this Short as a short.

static String toString(short s)

Returns a new String object representing the specified short.

String toString()

Returns a String object representing this Short's value.

static int toUnsignedInt(short x)

Converts the argument to an int by an unsigned conversion.

static long toUnsignedLong(short x)

Converts the argument to a long by an unsigned conversion.

static Short valueOf(String s)

Returns a Short object holding the value given by the specified String.

static Short valueOf(short s)

Returns a Short instance representing the specified short value.

static Short valueOf(String s, int radix)

Returns a Short object holding the value extracted from the specified String when parsed with the radix given by the second argument.

Inherited methods

Constants

BYTES

Added in API level 24
public static final int BYTES

The number of bytes used to represent a short value in two's complement binary form.

Constant Value: 2 (0x00000002)

MAX_VALUE

Added in API level 1
public static final short MAX_VALUE

A constant holding the maximum value a short can have, 215-1.

Constant Value: 32767 (0x00007fff)

MIN_VALUE

Added in API level 1
public static final short MIN_VALUE

A constant holding the minimum value a short can have, -215.

Constant Value: -32768 (0xffff8000)

SIZE

Added in API level 1
public static final int SIZE

The number of bits used to represent a short value in two's complement binary form.

Constant Value: 16 (0x00000010)

Fields

TYPE

Added in API level 1
public static final Class<Short> TYPE

The Class instance representing the primitive type short.

Public constructors

Short

Added in API level 1
public Short (String s)

This constructor is 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

Throws
NumberFormatException If the String does not contain a parsable short.

Short

Added in API level 1
public Short (short value)

This constructor is 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

byteValue

Added in API level 1
public byte byteValue ()

Returns the value of this Short as a byte after a narrowing primitive conversion.

Returns
byte the numeric value represented by this object after conversion to type byte.

compare

Added in API level 19
public static int compare (short x, 
                short y)

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

Returns
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

Added in API level 1
public int compareTo (Short anotherShort)

Compares two Short objects numerically.

Parameters
anotherShort Short: the Short to be compared.

Returns
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).

compareUnsigned

Added in API level 31
public static int compareUnsigned (short x, 
                short y)

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

Returns
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

Added in API level 1
public static Short decode (String nm)

Decodes a String into a Short. 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:
-
+
DecimalNumeral, HexDigits, and OctalDigits are as defined in section {@jls 3.10.1} of The Java Language Specification, except that underscores are not accepted between digits.

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.

Returns
Short a Short object holding the short value represented by nm

Throws
NumberFormatException if the String does not contain a parsable short.

doubleValue

Added in API level 1
public double doubleValue ()

Returns the value of this Short as a double after a widening primitive conversion.

Returns
double the numeric value represented by this object after conversion to type double.

equals

Added in API level 1
public boolean equals (Object obj)

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 Object: the object to compare with

Returns
boolean true if the objects are the same; false otherwise.

floatValue

Added in API level 1
public float floatValue ()

Returns the value of this Short as a float after a widening primitive conversion.

Returns
float the numeric value represented by this object after conversion to type float.

hashCode

Added in API level 24
public static int hashCode (short value)

Returns a hash code for a short value; compatible with Short.hashCode().

Parameters
value short: the value to hash

Returns
int a hash code value for a short value.

hashCode

Added in API level 1
public int hashCode ()

Returns a hash code for this Short; equal to the result of invoking intValue().

Returns
int a hash code value for this Short

intValue

Added in API level 1
public int intValue ()

Returns the value of this Short as an int after a widening primitive conversion.

Returns
int the numeric value represented by this object after conversion to type int.

longValue

Added in API level 1
public long longValue ()

Returns the value of this Short as a long after a widening primitive conversion.

Returns
long the numeric value represented by this object after conversion to type long.

parseShort

Added in API level 1
public static short parseShort (String s)

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 '-' ('\u002D') to indicate a negative value or an ASCII plus sign '+' ('\u002B') 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

Returns
short the short value represented by the argument in decimal.

Throws
NumberFormatException If the string does not contain a parsable short.

parseShort

Added in API level 1
public static short parseShort (String s, 
                int radix)

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 Character.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 resulting short 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 Character.MIN_RADIX or larger than 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 '-' ('\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 short.

Parameters
s String: the String containing the short representation to be parsed

radix int: the radix to be used while parsing s

Returns
short the short represented by the string argument in the specified radix.

Throws
NumberFormatException If the String does not contain a parsable short.

reverseBytes

Added in API level 1
public static short reverseBytes (short i)

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

Returns
short the value obtained by reversing (or, equivalently, swapping) the bytes in the specified short value.

shortValue

Added in API level 1
public short shortValue ()

Returns the value of this Short as a short.

Returns
short the numeric value represented by this object after conversion to type short.

toString

Added in API level 1
public static String toString (short s)

Returns a new String object representing the specified short. The radix is assumed to be 10.

Parameters
s short: the short to be converted

Returns
String the string representation of the specified short

toString

Added in API level 1
public String toString ()

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 toString(short) method.

Returns
String a string representation of the value of this object in base 10.

toUnsignedInt

Added in API level 26
public static int toUnsignedInt (short x)

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

Returns
int the argument converted to int by an unsigned conversion

toUnsignedLong

Added in API level 26
public static long toUnsignedLong (short x)

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

Returns
long the argument converted to long by an unsigned conversion

valueOf

Added in API level 1
public static Short valueOf (String s)

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

Returns
Short a Short object holding the value represented by the string argument

Throws
NumberFormatException If the String does not contain a parsable short.

valueOf

Added in API level 1
public static Short valueOf (short s)

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.

Returns
Short a Short instance representing s.

valueOf

Added in API level 1
public static Short valueOf (String s, 
                int radix)

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

Returns
Short a Short object holding the value represented by the string argument in the specified radix.

Throws
NumberFormatException If the String does not contain a parsable short.