Short (Java 2 Platform SE 5.0) (original) (raw)

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 Short class wraps a value of primitive typeshort in an object. An object of typeShort contains a single field whose type isshort.

In addition, this class provides several methods for converting ashort to a String and aString to a short, as well as other constants and methods useful when dealing with a short.

Since:

JDK1.1

See Also:

Number, Serialized Form

MIN_VALUE

public static final short MIN_VALUE

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

See Also:

Constant Field Values

MAX_VALUE

public static final short MAX_VALUE

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

See Also:

Constant Field Values

TYPE

public static final Class<Short> TYPE

The Class instance representing the primitive typeshort.

SIZE

public static final int SIZE

The number of bits used to represent a short value in two's complement binary form.

See Also:

Constant Field Values

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.

Short

public Short(String s) throws NumberFormatException

Constructs a newly allocated Short object that represents the short value indicated by theString parameter. The string is converted to ashort value in exactly the manner used by theparseShort method for radix 10.

Parameters:

s - the String to be converted to a Short

Throws:

[NumberFormatException](../../java/lang/NumberFormatException.html "class in java.lang") - If the String does not contain a parsable short.

See Also:

[parseShort(java.lang.String, int)](../../java/lang/Short.html#parseShort%28java.lang.String, int%29)

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

See Also:

Integer.toString(int)

parseShort

public static short parseShort(String s) throws NumberFormatException

Parses the string argument as a signed decimalshort. 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)](../../java/lang/Short.html#parseShort%28java.lang.String, int%29) method.

Parameters:

s - a String containing the short representation to be parsed

Returns:

the short value represented by the argument in decimal.

Throws:

[NumberFormatException](../../java/lang/NumberFormatException.html "class in java.lang") - If the string does not contain a parsable short.

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 [Character.digit(char, int)](../../java/lang/Character.html#digit%28char, int%29) 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 Character.MIN_RADIX or larger than Character.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 typeshort.

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](../../java/lang/NumberFormatException.html "class in java.lang") - If the String does not contain a parsable short.

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)](../../java/lang/Short.html#parseShort%28java.lang.String, int%29) 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](../../java/lang/NumberFormatException.html "class in java.lang") - If the String does not contain a parsable short.

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 decimalshort, exactly as if the argument were given to the parseShort(java.lang.String) method. The result is a Short object that represents theshort 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](../../java/lang/NumberFormatException.html "class in java.lang") - If the String does not contain a parsable short.

valueOf

public static Short valueOf(short s)

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

Parameters:

s - a short value.

Returns:

a Short instance representing s.

Since:

1.5

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

Parameters:

nm - the String to decode.

Returns:

a Short object holding the short value represented by nm

Throws:

[NumberFormatException](../../java/lang/NumberFormatException.html "class in java.lang") - if the String does not contain a parsable short.

See Also:

[parseShort(java.lang.String, int)](../../java/lang/Short.html#parseShort%28java.lang.String, int%29)

byteValue

public byte byteValue()

Returns the value of this Short as abyte.

Overrides:

[byteValue](../../java/lang/Number.html#byteValue%28%29) in class [Number](../../java/lang/Number.html "class in java.lang")

Returns:

the numeric value represented by this object after conversion to type byte.

shortValue

public short shortValue()

Returns the value of this Short as ashort.

Overrides:

[shortValue](../../java/lang/Number.html#shortValue%28%29) in class [Number](../../java/lang/Number.html "class in java.lang")

Returns:

the numeric value represented by this object after conversion to type short.

intValue

public int intValue()

Returns the value of this Short as anint.

Specified by:

[intValue](../../java/lang/Number.html#intValue%28%29) in class [Number](../../java/lang/Number.html "class in java.lang")

Returns:

the numeric value represented by this object after conversion to type int.

longValue

public long longValue()

Returns the value of this Short as along.

Specified by:

[longValue](../../java/lang/Number.html#longValue%28%29) in class [Number](../../java/lang/Number.html "class in java.lang")

Returns:

the numeric value represented by this object after conversion to type long.

floatValue

public float floatValue()

Returns the value of this Short as afloat.

Specified by:

[floatValue](../../java/lang/Number.html#floatValue%28%29) in class [Number](../../java/lang/Number.html "class in java.lang")

Returns:

the numeric value represented by this object after conversion to type float.

doubleValue

public double doubleValue()

Returns the value of this Short as adouble.

Specified by:

[doubleValue](../../java/lang/Number.html#doubleValue%28%29) in class [Number](../../java/lang/Number.html "class in java.lang")

Returns:

the numeric value represented by this object after conversion to type double.

toString

public String toString()

Returns a String object representing thisShort'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 thetoString(short) method.

Overrides:

[toString](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

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

hashCode

public int hashCode()

Returns a hash code for this Short.

Overrides:

[hashCode](../../java/lang/Object.html#hashCode%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object obj)

Compares this object to the specified object. The result istrue if and only if the argument is notnull and is a Short object that contains the same short value as this object.

Overrides:

[equals](../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Parameters:

obj - the object to compare with

Returns:

true if the objects are the same;false otherwise.

See Also:

Object.hashCode(), Hashtable

compareTo

public int compareTo(Short anotherShort)

Compares two Short objects numerically.

Specified by:

[compareTo](../../java/lang/Comparable.html#compareTo%28T%29) in interface [Comparable](../../java/lang/Comparable.html "interface in java.lang")<[Short](../../java/lang/Short.html "class in java.lang")>

Parameters:

anotherShort - the Short to be compared.

Returns:

the value 0 if this Short is equal to the argument Short; a value less than0 if this Short is numerically less than the argument Short; and a value greater than0 if this Short is numerically greater than the argument Short (signed comparison).

Since:

1.2

reverseBytes

public static short reverseBytes(short i)

Returns the value obtained by reversing the order of the bytes in the two's complement representation of the specified short value.

Returns:

the value obtained by reversing (or, equivalently, swapping) the bytes in the specified short value.

Since:

1.5

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.