java.lang
Class Short

java.lang.Object
  extended by java.lang.Number
      extended by java.lang.Short
All Implemented Interfaces:
Comparable

public final class Short
extends Number
implements Comparable

Instances of class Short represent primitive short values. Additionally, this class provides various helper functions and variables related to shorts.

Since:
1.1

Field Summary
static short MAX_VALUE
          The minimum value a short can represent is 32767 (or 215).
static short MIN_VALUE
          The minimum value a short can represent is -32768 (or -215).
static int SIZE
          The number of bits needed to represent a short.
static Class TYPE
          The primitive type short is represented by this Class object.
 
Constructor Summary
Short(short value)
          Create a Short object representing the value of the short argument.
Short(String s)
          Create a Short object representing the value of the argument after conversion to a short.
 
Method Summary
 byte byteValue()
          Return the value of this Short as a byte.
 int compareTo(Object o)
          Behaves like compareTo(Short) unless the Object is not a Short.
 int compareTo(Short s)
          Compare two Shorts numerically by comparing their short values.
static Short decode(String s)
          Convert the specified String into a Short.
 double doubleValue()
          Return the value of this Short as a double.
 boolean equals(Object obj)
          Returns true if obj is an instance of Short and represents the same short value.
 float floatValue()
          Return the value of this Short as a float.
 int hashCode()
          Return a hashcode representing this Object.
 int intValue()
          Return the value of this Short as an int.
 long longValue()
          Return the value of this Short as a long.
static short parseShort(String s)
          Converts the specified String into a short.
static short parseShort(String s, int radix)
          Converts the specified String into a short using the specified radix (base).
static short reverseBytes(short val)
          Reverse the bytes in val.
 short shortValue()
          Return the value of this Short.
 String toString()
          Converts the Short value to a String and assumes a radix of 10.
static String toString(short s)
          Converts the short to a String and assumes a radix of 10.
static Short valueOf(short val)
          Returns a Short object wrapping the value.
static Short valueOf(String s)
          Creates a new Short object using the String, assuming a radix of 10.
static Short valueOf(String s, int radix)
          Creates a new Short object using the String and specified radix (base).
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MIN_VALUE

public static final short MIN_VALUE
The minimum value a short can represent is -32768 (or -215).

See Also:
Constant Field Values

MAX_VALUE

public static final short MAX_VALUE
The minimum value a short can represent is 32767 (or 215).

See Also:
Constant Field Values

TYPE

public static final Class TYPE
The primitive type short is represented by this Class object.


SIZE

public static final int SIZE
The number of bits needed to represent a short.

Since:
1.5
See Also:
Constant Field Values
Constructor Detail

Short

public Short(short value)
Create a Short object representing the value of the short argument.

Parameters:
value - the value to use

Short

public Short(String s)
Create a Short object representing the value of the argument after conversion to a short.

Parameters:
s - the string to convert
Throws:
NumberFormatException - if the String cannot be parsed
Method Detail

toString

public static String toString(short s)
Converts the short to a String and assumes a radix of 10.

Parameters:
s - the short to convert to String
Returns:
the String representation of the argument

parseShort

public static short parseShort(String s)
Converts the specified String into a short. This function assumes a radix of 10.

Parameters:
s - the String to convert
Returns:
the short value of s
Throws:
NumberFormatException - if s cannot be parsed as a short

parseShort

public static short parseShort(String s,
                               int radix)
Converts the specified String into a short using the specified radix (base). The string must not be null or empty. It may begin with an optional '-', which will negate the answer, provided that there are also valid digits. Each digit is parsed as if by Character.digit(d, radix), and must be in the range 0 to radix - 1. Finally, the result must be within MIN_VALUE to MAX_VALUE, inclusive. Unlike Double.parseDouble, you may not have a leading '+'.

Parameters:
s - the String to convert
radix - the radix (base) to use in the conversion
Returns:
the String argument converted to short
Throws:
NumberFormatException - if s cannot be parsed as a short

valueOf

public static Short valueOf(String s,
                            int radix)
Creates a new Short object using the String and specified radix (base).

Parameters:
s - the String to convert
radix - the radix (base) to convert with
Returns:
the new Short
Throws:
NumberFormatException - if s cannot be parsed as a short
See Also:
parseShort(String, int)

valueOf

public static Short valueOf(String s)
Creates a new Short object using the String, assuming a radix of 10.

Parameters:
s - the String to convert
Returns:
the new Short
Throws:
NumberFormatException - if s cannot be parsed as a short
See Also:
Short(String), parseShort(String)

valueOf

public static Short valueOf(short val)
Returns a Short object wrapping the value. In contrast to the Short constructor, this method will cache some values. It is used by boxing conversion.

Parameters:
val - the value to wrap
Returns:
the Short
Since:
1.5

decode

public static Short decode(String s)
Convert the specified String into a Short. The String may represent decimal, hexadecimal, or octal numbers.

The extended BNF grammar is as follows:

 DecodableString:
      ( [ - ] DecimalNumber )
    | ( [ - ] ( 0x | 0X
              | # ) HexDigit { HexDigit } )
    | ( [ - ] 0 { OctalDigit } )
 DecimalNumber:
        DecimalDigit except '0' { DecimalDigit }
 DecimalDigit:
        Character.digit(d, 10) has value 0 to 9
 OctalDigit:
        Character.digit(d, 8) has value 0 to 7
 DecimalDigit:
        Character.digit(d, 16) has value 0 to 15
 
Finally, the value must be in the range MIN_VALUE to MAX_VALUE, or an exception is thrown.

Parameters:
s - the String to interpret
Returns:
the value of the String as a Short
Throws:
NumberFormatException - if s cannot be parsed as a short
NullPointerException - if s is null
See Also:
Integer.decode(String)

byteValue

public byte byteValue()
Return the value of this Short as a byte.

Overrides:
byteValue in class Number
Returns:
the byte value

shortValue

public short shortValue()
Return the value of this Short.

Overrides:
shortValue in class Number
Returns:
the short value

intValue

public int intValue()
Return the value of this Short as an int.

Specified by:
intValue in class Number
Returns:
the int value

longValue

public long longValue()
Return the value of this Short as a long.

Specified by:
longValue in class Number
Returns:
the long value

floatValue

public float floatValue()
Return the value of this Short as a float.

Specified by:
floatValue in class Number
Returns:
the float value

doubleValue

public double doubleValue()
Return the value of this Short as a double.

Specified by:
doubleValue in class Number
Returns:
the double value

toString

public String toString()
Converts the Short value to a String and assumes a radix of 10.

Overrides:
toString in class Object
Returns:
the String representation of this Short
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

hashCode

public int hashCode()
Return a hashcode representing this Object. Short's hash code is simply its value.

Overrides:
hashCode in class Object
Returns:
this Object's hash code
See Also:
Object.equals(Object), System.identityHashCode(Object)

equals

public boolean equals(Object obj)
Returns true if obj is an instance of Short and represents the same short value.

Overrides:
equals in class Object
Parameters:
obj - the object to compare
Returns:
whether these Objects are semantically equal
See Also:
Object.hashCode()

compareTo

public int compareTo(Short s)
Compare two Shorts numerically by comparing their short values. The result is positive if the first is greater, negative if the second is greater, and 0 if the two are equal.

Parameters:
s - the Short to compare
Returns:
the comparison
Since:
1.2

compareTo

public int compareTo(Object o)
Behaves like compareTo(Short) unless the Object is not a Short.

Specified by:
compareTo in interface Comparable
Parameters:
o - the object to compare
Returns:
the comparison
Throws:
ClassCastException - if the argument is not a Short
Since:
1.2
See Also:
compareTo(Short), Comparable

reverseBytes

public static short reverseBytes(short val)
Reverse the bytes in val.

Since:
1.5