- All Implemented Interfaces:
Serializable,Comparable<Short>,Constable
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.
- Since:
- 1.1
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe number of bytes used to represent ashortvalue in two's complement binary form.static final shortA constant holding the maximum value ashortcan have, 215-1.static final shortA constant holding the minimum value ashortcan have, -215.static final intThe number of bits used to represent ashortvalue in two's complement binary form.TheClassinstance representing the primitive typeshort. -
Constructor Summary
ConstructorsConstructorDescriptionShort(short value) Deprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor.Deprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor. -
Method Summary
Modifier and TypeMethodDescriptionbyteReturns the value of thisShortas abyteafter a narrowing primitive conversion.static intcompare(short x, short y) Compares twoshortvalues numerically.intCompares twoShortobjects numerically.static intcompareUnsigned(short x, short y) Compares twoshortvalues numerically treating the values as unsigned.static ShortDecodes aStringinto aShort.Returns anOptionalcontaining the nominal descriptor for this instance.doubleReturns the value of thisShortas adoubleafter a widening primitive conversion.booleanCompares this object to the specified object.floatReturns the value of thisShortas afloatafter a widening primitive conversion.inthashCode()Returns a hash code for thisShort; equal to the result of invokingintValue().static inthashCode(short value) Returns a hash code for ashortvalue; compatible withShort.hashCode().intintValue()Returns the value of thisShortas anintafter a widening primitive conversion.longReturns the value of thisShortas alongafter a widening primitive conversion.static shortparseShort(String s) Parses the string argument as a signed decimalshort.static shortparseShort(String s, int radix) Parses the string argument as a signedshortin the radix specified by the second argument.static shortreverseBytes(short i) Returns the value obtained by reversing the order of the bytes in the two's complement representation of the specifiedshortvalue.shortReturns the value of thisShortas ashort.toString()Returns aStringobject representing thisShort's value.static StringtoString(short s) Returns a newStringobject representing the specifiedshort.static inttoUnsignedInt(short x) Converts the argument to anintby an unsigned conversion.static longtoUnsignedLong(short x) Converts the argument to alongby an unsigned conversion.static ShortvalueOf(short s) Returns aShortinstance representing the specifiedshortvalue.static ShortReturns aShortobject holding the value given by the specifiedString.static ShortReturns aShortobject holding the value extracted from the specifiedStringwhen parsed with the radix given by the second argument.
-
Field Details
-
MIN_VALUE
public static final short MIN_VALUEA constant holding the minimum value ashortcan have, -215.- See Also:
-
MAX_VALUE
public static final short MAX_VALUEA constant holding the maximum value ashortcan have, 215-1.- See Also:
-
TYPE
TheClassinstance representing the primitive typeshort. -
SIZE
public static final int SIZEThe number of bits used to represent ashortvalue in two's complement binary form.- Since:
- 1.5
- See Also:
-
BYTES
public static final int BYTESThe number of bytes used to represent ashortvalue in two's complement binary form.- Since:
- 1.8
- See Also:
-
-
Constructor Details
-
Short
Deprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor. The static factoryvalueOf(short)is generally a better choice, as it is likely to yield significantly better space and time performance.Constructs a newly allocatedShortobject that represents the specifiedshortvalue.- Parameters:
value- the value to be represented by theShort.
-
Short
Deprecated, for removal: This API element is subject to removal in a future version.It is rarely appropriate to use this constructor. UseparseShort(String)to convert a string to ashortprimitive, or usevalueOf(String)to convert a string to aShortobject.Constructs a newly allocatedShortobject that represents theshortvalue indicated by theStringparameter. The string is converted to ashortvalue in exactly the manner used by theparseShortmethod for radix 10.- Parameters:
s- theStringto be converted to aShort- Throws:
NumberFormatException- If theStringdoes not contain a parsableshort.
-
-
Method Details
-
toString
Returns a newStringobject representing the specifiedshort. The radix is assumed to be 10.- Parameters:
s- theshortto be converted- Returns:
- the string representation of the specified
short - See Also:
-
parseShort
Parses the string argument as a signedshortin the radix specified by the second argument. The characters in the string must all be digits, of the specified radix (as determined by whetherCharacter.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 resultingshortvalue is returned.An exception of type
NumberFormatExceptionis 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
Character.MIN_RADIXor larger thanCharacter.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- theStringcontaining theshortrepresentation to be parsedradix- the radix to be used while parsings- Returns:
- the
shortrepresented by the string argument in the specified radix. - Throws:
NumberFormatException- If theStringdoes not contain a parsableshort.
- The first argument is
-
parseShort
Parses the string argument as a signed decimalshort. 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 resultingshortvalue is returned, exactly as if the argument and the radix 10 were given as arguments to theparseShort(java.lang.String, int)method.- Parameters:
s- aStringcontaining theshortrepresentation to be parsed- Returns:
- the
shortvalue represented by the argument in decimal. - Throws:
NumberFormatException- If the string does not contain a parsableshort.
-
valueOf
Returns aShortobject holding the value extracted from the specifiedStringwhen parsed with the radix given by the second argument. The first argument is interpreted as representing a signedshortin the radix specified by the second argument, exactly as if the argument were given to theparseShort(java.lang.String, int)method. The result is aShortobject that represents theshortvalue specified by the string.In other words, this method returns a
Shortobject equal to the value of:new Short(Short.parseShort(s, radix))- Parameters:
s- the string to be parsedradix- the radix to be used in interpretings- Returns:
- a
Shortobject holding the value represented by the string argument in the specified radix. - Throws:
NumberFormatException- If theStringdoes not contain a parsableshort.
-
valueOf
Returns aShortobject holding the value given by the specifiedString. The argument is interpreted as representing a signed decimalshort, exactly as if the argument were given to theparseShort(java.lang.String)method. The result is aShortobject that represents theshortvalue specified by the string.In other words, this method returns a
Shortobject equal to the value of:new Short(Short.parseShort(s))- Parameters:
s- the string to be parsed- Returns:
- a
Shortobject holding the value represented by the string argument - Throws:
NumberFormatException- If theStringdoes not contain a parsableshort.
-
describeConstable
Returns anOptionalcontaining the nominal descriptor for this instance.- Specified by:
describeConstablein interfaceConstable- Returns:
- an
Optionaldescribing the Short instance - Since:
- 15
-
valueOf
Returns aShortinstance representing the specifiedshortvalue. If a newShortinstance is not required, this method should generally be used in preference to the constructorShort(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- a short value.- Returns:
- a
Shortinstance representings. - Since:
- 1.5
-
decode
Decodes aStringinto aShort. Accepts decimal, hexadecimal, and octal numbers given by the following grammar:
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.- DecodableString:
- Signopt DecimalNumeral
- Signopt
0xHexDigits- Signopt
0XHexDigits- Signopt
#HexDigits- Signopt
0OctalDigits - Signopt
- Sign:
-+
The sequence of characters following an optional sign and/or radix specifier ("
0x", "0X", "#", or leading zero) is parsed as by theShort.parseShortmethod with the indicated radix (10, 16, or 8). This sequence of characters must represent a positive value or aNumberFormatExceptionwill be thrown. The result is negated if first character of the specifiedStringis the minus sign. No whitespace characters are permitted in theString.- Parameters:
nm- theStringto decode.- Returns:
- a
Shortobject holding theshortvalue represented bynm - Throws:
NumberFormatException- if theStringdoes not contain a parsableshort.- See Also:
-
byteValue
public byte byteValue()Returns the value of thisShortas abyteafter a narrowing primitive conversion.- Overrides:
byteValuein classNumber- Returns:
- the numeric value represented by this object after conversion
to type
byte. - See Java Language Specification:
-
5.1.3 Narrowing Primitive Conversion
-
shortValue
public short shortValue()Returns the value of thisShortas ashort.- Overrides:
shortValuein classNumber- Returns:
- the numeric value represented by this object after conversion
to type
short.
-
intValue
public int intValue()Returns the value of thisShortas anintafter a widening primitive conversion.- Specified by:
intValuein classNumber- Returns:
- the numeric value represented by this object after conversion
to type
int. - See Java Language Specification:
-
5.1.2 Widening Primitive Conversion
-
longValue
public long longValue()Returns the value of thisShortas alongafter a widening primitive conversion.- Specified by:
longValuein classNumber- Returns:
- the numeric value represented by this object after conversion
to type
long. - See Java Language Specification:
-
5.1.2 Widening Primitive Conversion
-
floatValue
public float floatValue()Returns the value of thisShortas afloatafter a widening primitive conversion.- Specified by:
floatValuein classNumber- Returns:
- the numeric value represented by this object after conversion
to type
float. - See Java Language Specification:
-
5.1.2 Widening Primitive Conversion
-
doubleValue
public double doubleValue()Returns the value of thisShortas adoubleafter a widening primitive conversion.- Specified by:
doubleValuein classNumber- Returns:
- the numeric value represented by this object after conversion
to type
double. - See Java Language Specification:
-
5.1.2 Widening Primitive Conversion
-
toString
Returns aStringobject representing thisShort's value. The value is converted to signed decimal representation and returned as a string, exactly as if theshortvalue were given as an argument to thetoString(short)method. -
hashCode
public int hashCode()Returns a hash code for thisShort; equal to the result of invokingintValue(). -
hashCode
public static int hashCode(short value) Returns a hash code for ashortvalue; compatible withShort.hashCode().- Parameters:
value- the value to hash- Returns:
- a hash code value for a
shortvalue. - Since:
- 1.8
-
equals
Compares this object to the specified object. The result istrueif and only if the argument is notnulland is aShortobject that contains the sameshortvalue as this object. -
compareTo
Compares twoShortobjects numerically.- Specified by:
compareToin interfaceComparable<Short>- Parameters:
anotherShort- theShortto be compared.- Returns:
- the value
0if thisShortis equal to the argumentShort; a value less than0if thisShortis numerically less than the argumentShort; and a value greater than0if thisShortis numerically greater than the argumentShort(signed comparison). - Since:
- 1.2
-
compare
public static int compare(short x, short y) Compares twoshortvalues numerically. The value returned is identical to what would be returned by:Short.valueOf(x).compareTo(Short.valueOf(y))- Parameters:
x- the firstshortto comparey- the secondshortto compare- Returns:
- the value
0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y - Since:
- 1.7
-
compareUnsigned
public static int compareUnsigned(short x, short y) Compares twoshortvalues numerically treating the values as unsigned.- Parameters:
x- the firstshortto comparey- the secondshortto compare- Returns:
- the value
0ifx == y; a value less than0ifx < yas unsigned values; and a value greater than0ifx > yas unsigned values - Since:
- 9
-
reverseBytes
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 specifiedshortvalue.- Parameters:
i- the value whose bytes are to be reversed- Returns:
- the value obtained by reversing (or, equivalently, swapping)
the bytes in the specified
shortvalue. - Since:
- 1.5
-
toUnsignedInt
public static int toUnsignedInt(short x) Converts the argument to anintby an unsigned conversion. In an unsigned conversion to anint, the high-order 16 bits of theintare zero and the low-order 16 bits are equal to the bits of theshortargument. Consequently, zero and positiveshortvalues are mapped to a numerically equalintvalue and negativeshortvalues are mapped to anintvalue equal to the input plus 216.- Parameters:
x- the value to convert to an unsignedint- Returns:
- the argument converted to
intby an unsigned conversion - Since:
- 1.8
-
toUnsignedLong
public static long toUnsignedLong(short x) Converts the argument to alongby an unsigned conversion. In an unsigned conversion to along, the high-order 48 bits of thelongare zero and the low-order 16 bits are equal to the bits of theshortargument. Consequently, zero and positiveshortvalues are mapped to a numerically equallongvalue and negativeshortvalues are mapped to alongvalue equal to the input plus 216.- Parameters:
x- the value to convert to an unsignedlong- Returns:
- the argument converted to
longby an unsigned conversion - Since:
- 1.8
-