Top Description Inners Fields Constructors Methods
java.lang

public final Class Short

extends Number
implements Comparable<Short>, Constable
Class Inheritance
All Implemented Interfaces
java.lang.constant.Constable, java.lang.Comparable
Annotations
@ValueBased
Imports
jdk.internal.misc.CDS, jdk.internal.vm.annotation.IntrinsicCandidate, .Stable, java.lang.constant.Constable, .DynamicConstantDesc, java.util.Optional

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.

This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail.

Authors
Nakul Saraiya, Joseph D. Darcy
Since
1.1
See Also
java.lang.Number

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
public static final int
BYTES

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

public static final short
MAX_VALUE

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

public static final short
MIN_VALUE

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

private static final long
serialVersionUID

Hides java.lang.Number.serialVersionUID.

use serialVersionUID from JDK 1.1.
public static final int
SIZE

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

public static final Class<Short>
TYPE

The Class instance representing the primitive type short.

private final short
value

The value of the Short.

Constructor Summary

AccessConstructor and Description
public
Short(short
the value to be represented by the Short.
value
)
Deprecated for removal since 9. It is rarely appropriate to use this constructor.

Constructs a newly allocated Short object that represents the specified short value.

public
Short(String
the String to be converted to a Short
s
)
Deprecated for removal since 9. It is rarely appropriate to use this constructor.

Constructs a newly allocated Short object that represents the short value indicated by the String parameter.

Method Summary

Modifier and TypeMethod and Description
public byte
byteValue()

Overrides java.lang.Number.byteValue.

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

public static int

Returns:

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y
compare
(short
the first short to compare
x
,
short
the second short to compare
y
)

Compares two short values numerically.

public int

Returns:

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).
compareTo
(Short
the Short to be compared.
anotherShort
)

Implements java.lang.Comparable.compareTo.

Compares two Short objects numerically.

public static int

Returns:

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
compareUnsigned
(short
the first short to compare
x
,
short
the second short to compare
y
)

Compares two short values numerically treating the values as unsigned.

public static Short

Returns:

a Short object holding the short value represented by nm
decode
(String
the String to decode.
nm
)

Decodes a String into a Short.

public Optional<DynamicConstantDesc<Short>>

Returns:

an Optional describing the Short instance
describeConstable
()

Implements java.lang.constant.Constable.describeConstable.

Returns an Optional containing the nominal descriptor for this instance.

public double
doubleValue()

Implements abstract java.lang.Number.doubleValue.

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

public boolean

Returns:

true if the objects are the same; false otherwise.
equals
(Object
the object to compare with
obj
)

Overrides java.lang.Object.equals.

Compares this object to the specified object.

public float
floatValue()

Implements abstract java.lang.Number.floatValue.

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

public int

Returns:

a hash code value for this Short
hashCode
()

Overrides java.lang.Object.hashCode.

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

public static int

Returns:

a hash code value for a short value.
hashCode
(short
the value to hash
value
)

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

public int
intValue()

Implements abstract java.lang.Number.intValue.

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

public long
longValue()

Implements abstract java.lang.Number.longValue.

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

public static short

Returns:

the short represented by the string argument in the specified radix.
parseShort
(String
the String containing the short representation to be parsed
s
,
int
the radix to be used while parsing s
radix
)

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

public static short

Returns:

the short value represented by the argument in decimal.
parseShort
(String
a String containing the short representation to be parsed
s
)

Parses the string argument as a signed decimal short.

public static short

Returns:

the value obtained by reversing (or, equivalently, swapping) the bytes in the specified short value.
reverseBytes
(short
the value whose bytes are to be reversed
i
)

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

public short
shortValue()

Overrides java.lang.Number.shortValue.

Returns the value of this Short as a short.

public static String

Returns:

the string representation of the specified short
toString
(short
the short to be converted
s
)

Returns a new String object representing the specified short.

public String

Returns:

a string representation of the value of this object in base 10.
toString
()

Overrides java.lang.Object.toString.

Returns a String object representing this Short's value.

public static int

Returns:

the argument converted to int by an unsigned conversion
toUnsignedInt
(short
the value to convert to an unsigned int
x
)

Converts the argument to an int by an unsigned conversion.

public static long

Returns:

the argument converted to long by an unsigned conversion
toUnsignedLong
(short
the value to convert to an unsigned long
x
)

Converts the argument to a long by an unsigned conversion.

public static Short

Returns:

a Short object holding the value represented by the string argument in the specified radix.
valueOf
(String
the string to be parsed
s
,
int
the radix to be used in interpreting s
radix
)

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

public static Short

Returns:

a Short object holding the value represented by the string argument
valueOf
(String
the string to be parsed
s
)

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

public static Short

Returns:

a Short instance representing s.
valueOf
(short
a short value.
s
)

Returns a Short instance representing the specified short value.

Field Detail

BYTESback to summary
public static final int BYTES

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

Since
1.8
MAX_VALUEback to summary
public static final short MAX_VALUE

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

MIN_VALUEback to summary
public static final short MIN_VALUE

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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Number.serialVersionUID.

use serialVersionUID from JDK 1.1. for interoperability

Annotations
@Serial
SIZEback to summary
public static final int SIZE

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

Since
1.5
TYPEback to summary
public static final Class<Short> TYPE

The Class instance representing the primitive type short.

Annotations
@SuppressWarnings:unchecked
valueback to summary
private final short value

The value of the Short.

Constructor Detail

Shortback to summary
public Short(short value)

Deprecated

for removal since 9.

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.

Annotations
@Deprecated
since:9
forRemoval:true
Shortback to summary
public Short(String s) throws NumberFormatException

Deprecated

for removal since 9.

It is rarely appropriate to use this constructor. Use parseShort(String) to convert a string to a short primitive, or use valueOf(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

Annotations
@Deprecated
since:9
forRemoval:true
Exceptions
NumberFormatException:
If the String does not contain a parsable short.

Method Detail

byteValueback to summary
public byte byteValue()

Overrides java.lang.Number.byteValue.

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

Returns:byte

Doc from java.lang.Number.byteValue.

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

Java Language Specification
5.1.3 Narrowing Primitive Conversion
compareback to summary
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

Since
1.7
compareToback to summary
public int compareTo(Short anotherShort)

Implements java.lang.Comparable.compareTo.

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

Since
1.2
compareUnsignedback to summary
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

Since
9
decodeback to summary
public static Short decode(String nm) throws NumberFormatException

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 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

Exceptions
NumberFormatException:
if the String does not contain a parsable short.
See Also
java.lang.Short#parseShort(java.lang.String, int)
describeConstableback to summary
public Optional<DynamicConstantDesc<Short>> describeConstable()

Implements java.lang.constant.Constable.describeConstable.

Returns an Optional containing the nominal descriptor for this instance.

Returns:Optional<DynamicConstantDesc<Short>>

an Optional describing the Short instance

Annotations
@Override
Since
15
doubleValueback to summary
public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

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

Returns:double

Doc from java.lang.Number.doubleValue.

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

Java Language Specification
5.1.2 Widening Primitive Conversion
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

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.

floatValueback to summary
public float floatValue()

Implements abstract java.lang.Number.floatValue.

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

Returns:float

Doc from java.lang.Number.floatValue.

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

Java Language Specification
5.1.2 Widening Primitive Conversion
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

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

Returns:int

a hash code value for this Short

Annotations
@Override
hashCodeback to summary
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.

Since
1.8
intValueback to summary
public int intValue()

Implements abstract java.lang.Number.intValue.

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

Returns:int

Doc from java.lang.Number.intValue.

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

Java Language Specification
5.1.2 Widening Primitive Conversion
longValueback to summary
public long longValue()

Implements abstract java.lang.Number.longValue.

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

Returns:long

Doc from java.lang.Number.longValue.

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

Java Language Specification
5.1.2 Widening Primitive Conversion
parseShortback to summary
public static short parseShort(String s, int radix) throws NumberFormatException

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 '-' ('\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 java.lang.Character#MIN_RADIX or larger than java.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 '-' ('\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.

Exceptions
NumberFormatException:
If the String does not contain a parsable short.
parseShortback to summary
public static short parseShort(String s) throws NumberFormatException

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.

Exceptions
NumberFormatException:
If the string does not contain a parsable short.
reverseBytesback to summary
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.

Annotations
@IntrinsicCandidate
Since
1.5
shortValueback to summary
public short shortValue()

Overrides java.lang.Number.shortValue.

Returns the value of this Short as a short.

Returns:short

Doc from java.lang.Number.shortValue.

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

Annotations
@IntrinsicCandidate
toStringback to summary
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

See Also
java.lang.Integer#toString(int)
toStringback to summary
public String toString()

Overrides java.lang.Object.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 java.lang.Short#toString(short) method.

Returns:String

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

Annotations
@Override
toUnsignedIntback to summary
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

Since
1.8
toUnsignedLongback to summary
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

Since
1.8
valueOfback to summary
public static Short valueOf(String s, int radix) throws NumberFormatException

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:

Short.valueOf(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.

Exceptions
NumberFormatException:
If the String does not contain a parsable short.
valueOfback to summary
public static Short valueOf(String s) throws NumberFormatException

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:

Short.valueOf(Short.parseShort(s))
Parameters
s:String

the string to be parsed

Returns:Short

a Short object holding the value represented by the string argument

Exceptions
NumberFormatException:
If the String does not contain a parsable short.
valueOfback to summary
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.

Annotations
@IntrinsicCandidate
Since
1.5
java.lang back to summary

private final Class Short.ShortCache

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv static Short[]
pack-priv static final Short[]

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

archivedCacheback to summary
pack-priv static Short[] archivedCache
cacheback to summary
pack-priv static final Short[] cache
Annotations
@Stable

Constructor Detail

ShortCacheback to summary
private ShortCache()