java.lang

Class Short

java.lang.Object

java.lang.Number

java.lang.Short

All Implemented Interfaces:

Serializable, Comparable<Short>

public final class Short
extends Number
implements Comparable<Short>

The wrapper for the primitive type short.

Since:

1.1

See Also:

Number, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	MAX_VALUE Constant for the maximum short value, 215-1.
static short	MIN_VALUE Constant for the minimum short value, -215.
static int	SIZE Constant for the number of bits needed to represent a short in two's complement form.
static Class<Short>	TYPE The Class object that represents the primitive type short.

Constructor Summary

Constructors

Constructor and Description
Short(short value) Constructs a new Short with the specified primitive short value.
Short(String string) Constructs a new Short from the specified string.

Method Summary

Modifier and Type	Method and Description
byte	byteValue() Returns this object's value as a byte.
static int	compare(short lhs, short rhs) Compares two short values.
int	compareTo(Short object) Compares this object to the specified short object to determine their relative order.
static Short	decode(String string) Parses the specified string and returns a Short instance if the string can be decoded into a short value.
double	doubleValue() Returns this object's value as a double.
boolean	equals(Object object) Compares this instance with the specified object and indicates if they are equal.
float	floatValue() Returns this object's value as a float.
int	hashCode() Returns an integer hash code for this object.
int	intValue() Returns this object's value as an int.
long	longValue() Returns this object's value as a long.
static short	parseShort(String string) Parses the specified string as a signed decimal short value.
static short	parseShort(String string, int radix) Parses the specified string as a signed short value using the specified radix.
static short	reverseBytes(short s) Reverses the bytes of the specified short.
short	shortValue() Gets the primitive value of this short.
String	toString() Returns a string containing a concise, human-readable description of this object.
static String	toString(short value) Returns a string containing a concise, human-readable description of the specified short value with radix 10.
static Short	valueOf(short s) Returns a Short instance for the specified short value.
static Short	valueOf(String string) Parses the specified string as a signed decimal short value.
static Short	valueOf(String string, int radix) Parses the specified string as a signed short value using the specified radix.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_VALUE

public static final short MAX_VALUE

Constant for the maximum short value, 2¹⁵-1.

See Also:

Constant Field Values

MIN_VALUE

public static final short MIN_VALUE

Constant for the minimum short value, -2¹⁵.

See Also:

Constant Field Values

SIZE

public static final int SIZE

Constant for the number of bits needed to represent a short in two's complement form.

Since:

1.5

See Also:

Constant Field Values

TYPE

public static final Class<Short> TYPE

The Class object that represents the primitive type short.

Constructor Detail

Short

public Short(String string)
      throws NumberFormatException

Constructs a new Short from the specified string.

Parameters:

string - the string representation of a short value.

Throws:

NumberFormatException - if string cannot be parsed as a short value.

See Also:

parseShort(String)

Short

public Short(short value)

Constructs a new Short with the specified primitive short value.

Parameters:

value - the primitive short value to store in the new instance.

Method Detail

byteValue

public byte byteValue()

Description copied from class: Number

Returns this object's value as a byte. Might involve rounding and/or truncating the value, so it fits into a byte.

Overrides:

byteValue in class Number

Returns:

the primitive byte value of this object.

compareTo

public int compareTo(Short object)

Compares this object to the specified short object to determine their relative order.

Specified by:

compareTo in interface Comparable<Short>

Parameters:

object - the short object to compare this object to.

Returns:

a negative value if the value of this short is less than the value of object; 0 if the value of this short and the value of object are equal; a positive value if the value of this short is greater than the value of object.

Throws:

NullPointerException - if object is null.

Since:

1.2

See Also:

Comparable

compare

public static int compare(short lhs,
                          short rhs)

Compares two short values.

Returns:

0 if lhs = rhs, less than 0 if lhs < rhs, and greater than 0 if lhs > rhs.

Since:

1.7

decode

public static Short decode(String string)
                    throws NumberFormatException

Parses the specified string and returns a Short instance if the string can be decoded into a short value. The string may be an optional minus sign "-" followed by a hexadecimal ("0x..." or "#..."), octal ("0..."), or decimal ("...") representation of a short.

Parameters:

string - a string representation of a short value.

Returns:

a Short containing the value represented by string.

Throws:

NumberFormatException - if string cannot be parsed as a short value.

doubleValue

public double doubleValue()

Description copied from class: Number

Returns this object's value as a double. Might involve rounding.

Specified by:

doubleValue in class Number

Returns:

the primitive double value of this object.

equals

public boolean equals(Object object)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, object must be an instance of Short and have the same short value as this object.

Overrides:

equals in class Object

Parameters:

object - the object to compare this short with.

Returns:

true if the specified object is equal to this Short; false otherwise.

See Also:

Object.hashCode()

floatValue

public float floatValue()

Description copied from class: Number

Returns this object's value as a float. Might involve rounding.

Specified by:

floatValue in class Number

Returns:

the primitive float value of this object.

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

intValue

public int intValue()

Description copied from class: Number

Returns this object's value as an int. Might involve rounding and/or truncating the value, so it fits into an int.

Specified by:

intValue in class Number

Returns:

the primitive int value of this object.

longValue

public long longValue()

Description copied from class: Number

Returns this object's value as a long. Might involve rounding and/or truncating the value, so it fits into a long.

Specified by:

longValue in class Number

Returns:

the primitive long value of this object.

parseShort

public static short parseShort(String string)
                        throws NumberFormatException

Parses the specified string as a signed decimal short value. The ASCII character - ('-') is recognized as the minus sign.

Parameters:

string - the string representation of a short value.

Returns:

the primitive short value represented by string.

Throws:

NumberFormatException - if string cannot be parsed as a short value.

parseShort

public static short parseShort(String string,
                               int radix)
                        throws NumberFormatException

Parses the specified string as a signed short value using the specified radix. The ASCII character - ('-') is recognized as the minus sign.

Parameters:

string - the string representation of a short value.

radix - the radix to use when parsing.

Returns:

the primitive short value represented by string using radix.

Throws:

NumberFormatException - if string cannot be parsed as a short value, or radix < Character.MIN_RADIX || radix > Character.MAX_RADIX.

shortValue

public short shortValue()

Gets the primitive value of this short.

Overrides:

shortValue in class Number

Returns:

this object's primitive value.

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.

toString

public static String toString(short value)

Returns a string containing a concise, human-readable description of the specified short value with radix 10.

Parameters:

value - the short to convert to a string.

Returns:

a printable representation of value.

valueOf

public static Short valueOf(String string)
                     throws NumberFormatException

Parses the specified string as a signed decimal short value.

Parameters:

string - the string representation of a short value.

Returns:

a Short instance containing the short value represented by string.

Throws:

NumberFormatException - if string cannot be parsed as a short value.

See Also:

parseShort(String)

valueOf

public static Short valueOf(String string,
                            int radix)
                     throws NumberFormatException

Parses the specified string as a signed short value using the specified radix.

Parameters:

string - the string representation of a short value.

radix - the radix to use when parsing.

Returns:

a Short instance containing the short value represented by string using radix.

Throws:

NumberFormatException - if string cannot be parsed as a short value, or radix < Character.MIN_RADIX || radix > Character.MAX_RADIX.

See Also:

parseShort(String, int)

reverseBytes

public static short reverseBytes(short s)

Reverses the bytes of the specified short.

Parameters:

s - the short value for which to reverse bytes.

Returns:

the reversed value.

Since:

1.5

valueOf

public static Short valueOf(short s)

Returns a Short instance for the specified short value.

If it is not necessary to get a new Short instance, it is recommended to use this method instead of the constructor, since it maintains a cache of instances which may result in better performance.

Parameters:

s - the short value to store in the instance.

Returns:

a Short instance containing s.

Since:

1.5