java.lang

Class Short

public final class Short extends Number implements Comparable<Short>

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.36, 05/21/03

Author: Nakul Saraiya

Field Summary
static short	MAX_VALUE A constant holding the maximum value a `short` can have, 2¹⁵-1.
static short	MIN_VALUE A constant holding the minimum value a `short` can have, -2¹⁵.
static Class<Short>	TYPE The `Class` instance representing the primitive type `short`.

Constructor Summary
	Short(short value) Constructs a newly allocated `Short` object that represents the specified `short` value.
	Short(String s) Constructs a newly allocated `Short` object that represents the `short` value indicated by the `String` parameter.

Method Summary
byte	byteValue() Returns the value of this `Short` as a `byte`.
int	compareTo(Short anotherShort) Compares two `Short` objects numerically.
static Short	decode(String nm) Decodes a `String` into a `Short`.
double	doubleValue() Returns the value of this `Short` as a `double`.
boolean	equals(Object obj) Compares this object to the specified object.
float	floatValue() Returns the value of this `Short` as a `float`.
int	hashCode() Returns a hash code for this `Short`.
int	intValue() Returns the value of this `Short` as an `int`.
long	longValue() Returns the value of this `Short` as a `long`.
static short	parseShort(String s) Parses the string argument as a signed decimal `short`.
static short	parseShort(String s, int radix) Parses the string argument as a signed `short` in the radix specified by the second argument.
short	shortValue() Returns the value of this `Short` as a `short`.
static String	toString(short s) Returns a new `String` object representing the specified `short`.
String	toString() Returns a `String` object representing this `Short`'s value.
static Short	valueOf(String s, int radix) Returns a `Short` object holding the value extracted from the specified `String` when parsed with the radix given by the second argument.
static Short	valueOf(String s) Returns a `Short` object holding the value given by the specified `String`.
static Short	valueOf(short s) Returns a `Short` instance representing the specified `short` value.

Field Detail

MAX_VALUE

public static final short MAX_VALUE

A constant holding the maximum value a short can have, 2¹⁵-1.

MIN_VALUE

public static final short MIN_VALUE

A constant holding the minimum value a short can have, -2¹⁵.

TYPE

public static final Class<Short> TYPE

The Class instance representing the primitive type short.

Constructor Detail

Short

public Short(short value)

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

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

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

Throws: NumberFormatException If the String does not contain a parsable short.

Method Detail

byteValue

public byte byteValue()

Returns the value of this Short as a byte.

compareTo

public int compareTo(Short anotherShort)

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

decode

public static Short decode(String nm)

Decodes a String into a Short. Accepts decimal, hexadecimal, and octal numbers given by the following grammar:

DecodableString:
Sign_opt DecimalNumeral
Sign_opt 0x HexDigits
Sign_opt 0X HexDigits
Sign_opt # HexDigits
Sign_opt 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

Throws: NumberFormatException if the String does not contain a parsable short.

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.

Parameters: obj the object to compare with

Returns: true if the objects are the same; false otherwise.

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.

parseShort

public static short parseShort(String s)

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 Short method.

Parameters: s a String containing the short representation to be parsed

Returns: the short value represented by the argument in decimal.

Throws: NumberFormatException If the string does not contain a parsable short.

parseShort

public static short parseShort(String s, int radix)

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

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.

Throws: NumberFormatException If the String does not contain a parsable short.

shortValue

public short shortValue()

Returns the value of this Short as a short.

toString

public static String toString(short s)

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

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 Short method.

Returns: a string representation of the value of this object in base 10.

valueOf

public static Short valueOf(String s, int radix)

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

Throws: NumberFormatException If the String does not contain a parsable short.

valueOf

public static Short valueOf(String s)

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

Throws: NumberFormatException If the String does not contain a parsable short.

valueOf

public static Short valueOf(short s)

Returns a Short instance representing the specified short value. If a new Short instance is not required, this method should generally be used in preference to the constructor Short, as this method is likely to to yield significantly better space and time performance by cacheing frequently requested values.

Parameters: s a short value.

Returns: a Short instance representing s.

Since: 1.5