Overview  Package   Class  Tree  Deprecated  Index  Help  Legend 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.lang
Class Short

java.lang.Object
  |
  +--java.lang.Number
        |
        +--java.lang.Short
All Implemented Interfaces:
Comparable, Serializable
public final class Short
extends Number
implements Comparable

Safe: 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.

Since:
JDK1.1
Version:
1.32, 02/06/02
Author:
Nakul Saraiya
See Also:
java.lang.Number, Serialized Form

Field Summary
static short MAX_VALUE
          Enabled: A constant holding the maximum value a short can have, 215-1.
static short MIN_VALUE
          Enabled: A constant holding the minimum value a short can have, -215.
private static long serialVersionUID
          use serialVersionUID from JDK 1.1.
static Class TYPE
          Enabled: The Class instance representing the primitive type short.
private  short value
          The value of the Short.
 
Constructor Summary
Short(short value)
          Enabled: Constructs a newly allocated Short object that represents the specified short value.
Short(String s)
          Enabled: Constructs a newly allocated Short object that represents the short value indicated by the String parameter.
 
Method Summary
 byte byteValue()
          Enabled: Returns the value of this Short as a byte.
 int compareTo(Object o)
          Enabled: Compares this Short object to another object.
 int compareTo(Short anotherShort)
          Suppressed: Compares two Short objects numerically.
static Short decode(String nm)
          Enabled: Decodes a String into a Short.
 double doubleValue()
          Enabled: Returns the value of this Short as a double.
 boolean equals(Object obj)
          Suppressed: Compares this object to the specified object.
 float floatValue()
          Enabled: Returns the value of this Short as a float.
 int hashCode()
          Suppressed: Returns a hash code for this Short.
 int intValue()
          Enabled: Returns the value of this Short as an int.
 long longValue()
          Enabled: Returns the value of this Short as a long.
static short parseShort(String s)
          Enabled: Parses the string argument as a signed decimal short.
static short parseShort(String s, int radix)
          Enabled: Parses the string argument as a signed short in the radix specified by the second argument.
 short shortValue()
          Enabled: Returns the value of this Short as a short.
 String toString()
          Suppressed: Returns a String object representing this Short's value.
static String toString(short s)
          Enabled: Returns a new String object representing the specified short.
static Short valueOf(String s)
          Enabled: Returns a Short object holding the value given by the specified String.
static Short valueOf(String s, int radix)
          Enabled: Returns a Short object holding the value extracted from the specified String when parsed with the radix given by the second argument.
 
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
Enabled: A constant holding the minimum value a short can have, -215.

MAX_VALUE

public static final short MAX_VALUE
Enabled: A constant holding the maximum value a short can have, 215-1.

TYPE

public static final Class TYPE
Enabled: The Class instance representing the primitive type short.

value

private short value
The value of the Short.

serialVersionUID

private static final long serialVersionUID
use serialVersionUID from JDK 1.1. for interoperability

Constructor Detail

Short

public Short(short value)
Enabled: Constructs a newly allocated Short object that represents the specified short value.

Parameters:
value - the value to be represented by the Short.

Short

public Short(String s)
      throws NumberFormatException
Enabled: 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 - the String to be converted to a Short
See Also:
java.lang.Short#parseShort(java.lang.String, int)
Method Detail

toString

public static String toString(short s)
Enabled: Returns a new String object representing the specified short. The radix is assumed to be 10.

Parameters:
s - the short to be converted
Returns:
the string representation of the specified short
See Also:
java.lang.Integer#toString(int)

parseShort

public static short parseShort(String s)
                        throws NumberFormatException
Enabled: 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. 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 - a String containing the short representation to be parsed
Returns:
the short value represented by the argument in decimal.
NumberFormatException

parseShort

public static short parseShort(String s,
                               int radix)
                        throws NumberFormatException
Enabled: 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. The resulting byte value is returned.

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

Parameters:
s - the String containing the short representation to be parsed
radix - the radix to be used while parsing s
Returns:
the short represented by the string argument in the specified radix.
NumberFormatException

valueOf

public static Short valueOf(String s,
                            int radix)
                     throws NumberFormatException
Enabled: 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 - the string to be parsed
radix - the radix to be used in interpreting s
Returns:
a Short object holding the value represented by the string argument in the specified radix.
NumberFormatException

valueOf

public static Short valueOf(String s)
                     throws NumberFormatException
Enabled: 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 Byte object equal to the value of:

new Short(Short.parseShort(s))

Parameters:
s - the string to be parsed
Returns:
a Short object holding the value represented by the string argument
NumberFormatException

decode

public static Short decode(String nm)
                    throws NumberFormatException
Enabled: 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 defined in §3.10.1 of the Java Language Specification.

The sequence of characters following an (optional) negative 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 - the String to decode.
Returns:
a Short object holding the short value represented by nm
NumberFormatException
See Also:
java.lang.Short#parseShort(java.lang.String, int)

byteValue

public byte byteValue()
Enabled: Returns the value of this Short as a byte.

Overrides:
byteValue in class Number
Returns:
the numeric value represented by this object after conversion to type byte.

shortValue

public short shortValue()
Enabled: Returns the value of this Short as a short.

Overrides:
shortValue in class Number
Returns:
the numeric value represented by this object after conversion to type short.

intValue

public int intValue()
Enabled: Returns the value of this Short as an int.

Specified by:
intValue in class Number
Returns:
the numeric value represented by this object after conversion to type int.

longValue

public long longValue()
Enabled: Returns the value of this Short as a long.

Specified by:
longValue in class Number
Returns:
the numeric value represented by this object after conversion to type long.

floatValue

public float floatValue()
Enabled: Returns the value of this Short as a float.

Specified by:
floatValue in class Number
Returns:
the numeric value represented by this object after conversion to type float.

doubleValue

public double doubleValue()
Enabled: Returns the value of this Short as a double.

Specified by:
doubleValue in class Number
Returns:
the numeric value represented by this object after conversion to type double.

toString

public String toString()
Suppressed: 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.

Overrides:
toString in class Object
Returns:
a string representation of the value of this object in base 10.

hashCode

public int hashCode()
Suppressed: Returns a hash code for this Short.

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
java.lang.Object#equals(java.lang.Object), java.util.Hashtable

equals

public boolean equals(Object obj)
Suppressed: 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.

Overrides:
equals in class Object
Parameters:
obj - the object to compare with
Returns:
true if the objects are the same; false otherwise.
See Also:
Object.hashCode(), java.util.Hashtable

compareTo

public int compareTo(Short anotherShort)
Suppressed: Compares two Short objects numerically.

Parameters:
anotherShort - the Short to be compared.
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).
Since:
1.2

compareTo

public int compareTo(Object o)
Enabled: Compares this Short object to another object. If the object is a Short, this function behaves like compareTo(Short). Otherwise, it throws a ClassCastException (as Short objects are only comparable to other Short objects).

Specified by:
compareTo in interface Comparable
Parameters:
o - the Object to be compared.
Returns:
the value 0 if the argument is a Short numerically equal to this Short; a value less than 0 if the argument is a Short numerically greater than this Short; and a value greater than 0 if the argument is a Short numerically less than this Short.
Since:
1.2
See Also:
java.lang.Comparable
Overview  Package   Class  Tree  Deprecated  Index  Help  Legend 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
comments?