Documentation  › java.lang  › Short
 
 


  Short
  public final

  Inherits From:   Number : Object
  Conforms To:   Comparable
  Declared In:   java.lang


Class Description
 
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.



Class Variables
 
MIN_VALUE
public static final short

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


MAX_VALUE
public static final short

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


TYPE
public static final Class

The Class instance representing the primitive type short.


Instance Variables
 
None declared in this class.


Constructors
 
Short
public Short( short value )

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


Short
public Short( String s ) throws NumberFormatException

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.


Class Methods
 
decode
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 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.


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


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

  • The first argument is null or is a string of length zero.
  • The radix is either smaller than MIN_RADIX or larger than 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') provided that the string is longer than length 1.
  • The value represented by the string is not a value of type short.



toString
public static String toString( short s )

Returns a new String object representing the specified short. The radix is assumed to be 10.


valueOf
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 Byte object equal to the value of:

new Short(Short.parseShort(s))



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

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


Instance Methods
 
byteValue
public byte byteValue( )

Returns the value of this Short as a byte.


compareTo
public int compareTo( Object o )

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


compareTo
public int compareTo( Short anotherShort )

Compares two Short objects numerically.


doubleValue
public double doubleValue( )

Returns the value of this Short as a double.


equals
public boolean equals( Object obj )

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.


floatValue
public float floatValue( )

Returns the value of this Short as a float.


hashCode
public int hashCode( )

Returns a hash code for this Short.


intValue
public int intValue( )

Returns the value of this Short as an int.


longValue
public long longValue( )

Returns the value of this Short as a long.


shortValue
public short shortValue( )

Returns the value of this Short as a short.


toString
public String 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 toString(short) method.


Known Subclasses
 
None.



 
 
  dydoc
  3/10/05