Class Short

java.lang.Object
java.lang.Number
java.lang.Short
All Implemented Interfaces:
Serializable,Comparable<Short>,Constable

public final classShortextendsNumberimplementsComparable<Short>,Constable
TheShort class is thewrapper class for values of the primitive typeshort. An object of typeShort contains a single field whose type isshort.

In addition, this class provides several methods for converting ashort to aString and aString to ashort, as well as other constants and methods useful when dealing with ashort.

This is avalue-based class; programmers should treat instances that areequal 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The number of bytes used to represent ashort value in two's complement binary form.
    static final short
    A constant holding the maximum value ashort can have, 215-1.
    static final short
    A constant holding the minimum value ashort can have, -215.
    static final int
    The number of bits used to represent ashort value in two's complement binary form.
    static finalClass<Short>
    TheClass instance representing the primitive typeshort.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Short(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 Type
    Method
    Description
    byte
    Returns the value of thisShort as abyte after a narrowing primitive conversion.
    static int
    compare(short x, short y)
    Compares twoshort values numerically.
    int
    compareTo(Short anotherShort)
    Compares twoShort objects numerically.
    static int
    compareUnsigned(short x, short y)
    Compares twoshort values numerically treating the values as unsigned.
    staticShort
    Decodes aString into aShort.
    Returns anOptional containing the nominal descriptor for this instance.
    double
    Returns the value of thisShort as adouble after a widening primitive conversion.
    boolean
    Compares this object to the specified object.
    float
    Returns the value of thisShort as afloat after a widening primitive conversion.
    int
    Returns a hash code for thisShort; equal to the result of invokingintValue().
    static int
    hashCode(short value)
    Returns a hash code for ashort value; compatible withShort.hashCode().
    int
    Returns the value of thisShort as anint after a widening primitive conversion.
    long
    Returns the value of thisShort as along after a widening primitive conversion.
    static short
    Parses the string argument as a signed decimal short.
    static short
    parseShort(String s, int radix)
    Parses the string argument as a signedshort 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 specifiedshort value.
    short
    Returns the value of thisShort as ashort.
    Returns aString object representing thisShort's value.
    staticString
    toString(short s)
    Returns a newString object representing the specifiedshort.
    static int
    toUnsignedInt(short x)
    Converts the argument to anint by an unsigned conversion.
    static long
    toUnsignedLong(short x)
    Converts the argument to along by an unsigned conversion.
    staticShort
    valueOf(short s)
    Returns aShort instance representing the specifiedshort value.
    staticShort
    Returns aShort object holding the value given by the specifiedString.
    staticShort
    valueOf(String s, int radix)
    Returns aShort object holding the value extracted from the specifiedString when parsed with the radix given by the second argument.

    Methods declared in class java.lang.Object

    clone,finalize,getClass,notify,notifyAll,wait,wait,wait
  • Field Details

    • MIN_VALUE

      public static final short MIN_VALUE
      A constant holding the minimum value ashort can have, -215.
      See Also:
    • MAX_VALUE

      public static final short MAX_VALUE
      A constant holding the maximum value ashort can have, 215-1.
      See Also:
    • TYPE

      public static final Class<Short> TYPE
      TheClass instance representing the primitive typeshort.
    • SIZE

      public static final int SIZE
      The number of bits used to represent ashort value in two's complement binary form.
      Since:
      1.5
      See Also:
    • BYTES

      public static final int BYTES
      The number of bytes used to represent ashort value in two's complement binary form.
      Since:
      1.8
      See Also:
  • Constructor Details

    • Short

      @Deprecated(since="9",forRemoval=true)public Short(short value)
      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 allocatedShort object that represents the specifiedshort value.
      Parameters:
      value - the value to be represented by theShort.
    • Short

      @Deprecated(since="9",forRemoval=true)public Short(String s) throwsNumberFormatException
      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 ashort primitive, or usevalueOf(String) to convert a string to aShort object.
      Constructs a newly allocatedShort object that represents theshort value indicated by theString parameter. The string is converted to ashort value in exactly the manner used by theparseShort method for radix 10.
      Parameters:
      s - theString to be converted to aShort
      Throws:
      NumberFormatException - If theString does not contain a parsableshort.
  • Method Details

    • toString

      public static String toString(short s)
      Returns a newString object representing the specifiedshort. The radix is assumed to be 10.
      Parameters:
      s - theshort to be converted
      Returns:
      the string representation of the specifiedshort
      See Also:
    • parseShort

      public static short parseShort(String s, int radix) throwsNumberFormatException
      Parses the string argument as a signedshort in 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 resultingshort value is returned.

      An exception of typeNumberFormatException is thrown if any of the following situations occurs:

      • The first argument isnull or is a string of length zero.
      • The radix is either smaller thanCharacter.MIN_RADIX or 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 typeshort.

      Parameters:
      s - theString containing theshort representation to be parsed
      radix - the radix to be used while parsings
      Returns:
      theshort represented by the string argument in the specified radix.
      Throws:
      NumberFormatException - If theString does not contain a parsableshort.
    • parseShort

      public static short parseShort(String s) throwsNumberFormatException
      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 resultingshort value is returned, exactly as if the argument and the radix 10 were given as arguments to theparseShort(java.lang.String, int) method.
      Parameters:
      s - aString containing theshort representation to be parsed
      Returns:
      theshort value represented by the argument in decimal.
      Throws:
      NumberFormatException - If the string does not contain a parsableshort.
    • valueOf

      public static Short valueOf(String s, int radix) throwsNumberFormatException
      Returns aShort object holding the value extracted from the specifiedString when parsed with the radix given by the second argument. The first argument is interpreted as representing a signedshort in the radix specified by the second argument, exactly as if the argument were given to theparseShort(java.lang.String, int) method. The result is aShort object that represents theshort value specified by the string.

      In other words, this method returns aShort object equal to the value of:

      Short.valueOf(Short.parseShort(s, radix))

      Parameters:
      s - the string to be parsed
      radix - the radix to be used in interpretings
      Returns:
      aShort object holding the value represented by the string argument in the specified radix.
      Throws:
      NumberFormatException - If theString does not contain a parsableshort.
    • valueOf

      public static Short valueOf(String s) throwsNumberFormatException
      Returns aShort object 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 aShort object that represents theshort value specified by the string.

      In other words, this method returns aShort object equal to the value of:

      Short.valueOf(Short.parseShort(s))

      Parameters:
      s - the string to be parsed
      Returns:
      aShort object holding the value represented by the string argument
      Throws:
      NumberFormatException - If theString does not contain a parsableshort.
    • describeConstable

      public Optional<DynamicConstantDesc<Short>> describeConstable()
      Returns anOptional containing the nominal descriptor for this instance.
      Specified by:
      describeConstable in interface Constable
      Returns:
      anOptional describing theShort instance
      Since:
      15
    • valueOf

      public static Short valueOf(short s)
      Returns aShort instance representing the specifiedshort value. If a newShort instance 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:
      aShort instance representings.
      Since:
      1.5
    • decode

      public static Short decode(String nm) throwsNumberFormatException
      Decodes aString into aShort. Accepts decimal, hexadecimal, and octal numbers given by the following grammar:
      DecodableString:
      Signopt DecimalNumeral
      Signopt0xHexDigits
      Signopt0XHexDigits
      Signopt#HexDigits
      Signopt0OctalDigits
      Sign:
      -
      +
      DecimalNumeral,HexDigits, andOctalDigits are as defined in section3.10.1 ofThe 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 aNumberFormatException will be thrown. The result is negated if first character of the specified String is the minus sign. No whitespace characters are permitted in theString.

      Parameters:
      nm - theString to decode.
      Returns:
      aShort object holding theshort value represented bynm
      Throws:
      NumberFormatException - if theString does not contain a parsableshort.
      See Also:
    • byteValue

      public byte byteValue()
      Returns the value of thisShort as abyte after a narrowing primitive conversion.
      Overrides:
      byteValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typebyte.
      SeeJava Language Specification:
      5.1.3 Narrowing Primitive Conversion
    • shortValue

      public short shortValue()
      Returns the value of thisShort as ashort.
      Overrides:
      shortValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typeshort.
    • intValue

      public int intValue()
      Returns the value of thisShort as anint after a widening primitive conversion.
      Specified by:
      intValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typeint.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • longValue

      public long longValue()
      Returns the value of thisShort as along after a widening primitive conversion.
      Specified by:
      longValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typelong.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • floatValue

      public float floatValue()
      Returns the value of thisShort as afloat after a widening primitive conversion.
      Specified by:
      floatValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typefloat.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • doubleValue

      public double doubleValue()
      Returns the value of thisShort as adouble after a widening primitive conversion.
      Specified by:
      doubleValue in class Number
      Returns:
      the numeric value represented by this object after conversion to typedouble.
      SeeJava Language Specification:
      5.1.2 Widening Primitive Conversion
    • toString

      public String toString()
      Returns aString object representing thisShort's value. The value is converted to signed decimal representation and returned as a string, exactly as if theshort value were given as an argument to thetoString(short) method.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the value of this object in base 10.
    • hashCode

      public int hashCode()
      Returns a hash code for thisShort; equal to the result of invokingintValue().
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for thisShort
      See Also:
    • hashCode

      public static int hashCode(short value)
      Returns a hash code for ashort value; compatible withShort.hashCode().
      Parameters:
      value - the value to hash
      Returns:
      a hash code value for ashort value.
      Since:
      1.8
    • equals

      public boolean equals(Object obj)
      Compares this object to the specified object. The result istrue if and only if the argument is notnull and is aShort object that contains the sameshort value as this object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare with
      Returns:
      true if the objects are the same;false otherwise.
      See Also:
    • compareTo

      public int compareTo(Short anotherShort)
      Compares twoShort objects numerically.
      Specified by:
      compareTo in interface Comparable<Short>
      Parameters:
      anotherShort - theShort to be compared.
      Returns:
      the value0 if thisShort is equal to the argumentShort; a value less than0 if thisShort is numerically less than the argumentShort; and a value greater than0 if thisShort is numerically greater than the argumentShort (signed comparison).
      Since:
      1.2
    • compare

      public static int compare(short x, short y)
      Compares twoshort values numerically. The value returned is identical to what would be returned by:
          Short.valueOf(x).compareTo(Short.valueOf(y))
      Parameters:
      x - the firstshort to compare
      y - the secondshort to compare
      Returns:
      the value0 ifx == y; a value less than0 ifx < y; and a value greater than0 ifx > y
      Since:
      1.7
    • compareUnsigned

      public static int compareUnsigned(short x, short y)
      Compares twoshort values numerically treating the values as unsigned.
      Parameters:
      x - the firstshort to compare
      y - the secondshort to compare
      Returns:
      the value0 ifx == y; a value less than0 ifx < y as unsigned values; and a value greater than0 ifx > y as 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 specifiedshort value.
      Parameters:
      i - the value whose bytes are to be reversed
      Returns:
      the value obtained by reversing (or, equivalently, swapping) the bytes in the specifiedshort value.
      Since:
      1.5
    • toUnsignedInt

      public static int toUnsignedInt(short x)
      Converts the argument to anint by an unsigned conversion. In an unsigned conversion to anint, the high-order 16 bits of theint are zero and the low-order 16 bits are equal to the bits of theshort argument. Consequently, zero and positiveshort values are mapped to a numerically equalint value and negative short values are mapped to anint value equal to the input plus 216.
      Parameters:
      x - the value to convert to an unsignedint
      Returns:
      the argument converted toint by an unsigned conversion
      Since:
      1.8
    • toUnsignedLong

      public static long toUnsignedLong(short x)
      Converts the argument to along by an unsigned conversion. In an unsigned conversion to along, the high-order 48 bits of thelong are zero and the low-order 16 bits are equal to the bits of theshort argument. Consequently, zero and positiveshort values are mapped to a numerically equallong value and negative short values are mapped to along value equal to the input plus 216.
      Parameters:
      x - the value to convert to an unsignedlong
      Returns:
      the argument converted tolong by an unsigned conversion
      Since:
      1.8