|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class Short
java.lang.Short
All Implemented Interfaces:
public final class 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.
This is a value-based
class; programmers should treat instances that are
equal as interchangeable and should not
use instances for synchronization, or unpredictable behavior may
occur. For example, in a future release, synchronization may fail.
Since:
1.1
Author:
Nakul Saraiya, Joseph D. Darcy
See Also:
Field Summary |
static final int |
The number of bytes used to represent a short value in two's
complement binary form.
|
static final short |
A constant holding the maximum value a short can
have, 215-1.
|
static final short |
A constant holding the minimum value a short can
have, -215.
|
static final int |
The number of bits used to represent a short value in two's
complement binary form.
|
|
The Class instance representing the primitive type
short.
|
Constructor Summary |
Deprecated, for removal. It is rarely appropriate to use this constructor.
|
Deprecated, for removal. It is rarely appropriate to use this constructor.
|
Method Summary |
byte |
Returns the value of this Short as a byte after
a narrowing primitive conversion.
|
static int |
Compares two short values numerically.
|
int |
Compares two Short objects numerically.
|
static int |
Compares two short values numerically treating the values
as unsigned.
|
|
Decodes a String into a Short.
|
|
Returns an Optional containing the nominal descriptor for this
instance.
|
double |
Returns the value of this Short as a double
after a widening primitive conversion.
|
boolean |
Compares this object to the specified object.
|
float |
Returns the value of this Short as a float
after a widening primitive conversion.
|
int |
Returns a hash code for this Short; equal to the result
of invoking intValue().
|
static int |
Returns a hash code for a short value; compatible with
Short.hashCode().
|
int |
Returns the value of this Short as an int after
a widening primitive conversion.
|
long |
Returns the value of this Short as a long after
a widening primitive conversion.
|
static short |
Parses the string argument as a signed decimal
short.
|
static short |
Parses the string argument as a signed short in the
radix specified by the second argument.
|
static short |
Returns the value obtained by reversing the order of the bytes in the
two's complement representation of the specified short value.
|
short |
Returns the value of this Short as a
short.
|
|
Returns a String object representing this
Short's value.
|
|
Returns a new String object representing the
specified short.
|
static int |
Converts the argument to an int by an unsigned
conversion.
|
static long |
Converts the argument to a long by an unsigned
conversion.
|
|
Returns a Short instance representing the specified
short value.
|
|
Returns a Short object holding the
value given by the specified String.
|
|
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 |
|
public static final short MIN_VALUE
A constant holding the minimum value a
short can
have, -2
15.
See Also:
public static final short MAX_VALUE
A constant holding the maximum value a
short can
have, 2
15-1.
See Also:
The Class instance representing the primitive type
short.
public static final int SIZE
The number of bits used to represent a
short value in two's
complement binary form.
Since:
1.5
See Also:
public static final int BYTES
The number of bytes used to represent a
short value in two's
complement binary form.
Since:
1.8
See Also:
public Short |
(short value) |
Deprecated, for removal. It is rarely appropriate to use this constructor. The static factory
valueOf(short) is generally a better choice, as it is
likely to yield significantly better space and time performance.
Constructs a newly allocated Short object that
represents the specified short value.
Parameters:
value - the value to be represented by the
Short.
Deprecated, for removal. It is rarely appropriate to use this constructor.
Use parseShort(String) to convert a string to a
short primitive, or use valueOf(String)
to convert a string to a Short object.
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:
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:
public static short parseShort |
|
throws |
|
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) returns a nonnegative value) except that the first
character may be an ASCII minus sign
'-'
(
'\u002D') to indicate a negative value or an
ASCII plus sign
'+' (
'\u002B') to
indicate a positive value. The resulting
short 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') or plus sign
'+' ('\u002B') 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:
public static short parseShort |
|
throws |
|
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 or an ASCII plus sign
'+'
(
'\u002B') to indicate a positive 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.
Throws:
public static Short valueOf |
|
throws |
|
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.
Throws:
public static Short valueOf |
|
throws |
|
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 Short 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:
Returns an
Optional containing the nominal descriptor for this
instance.
Specified by:
Returns:
Since:
15
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(short), as this method is likely to yield
significantly better space and time performance by caching
frequently requested values.
This method will always cache values in the range -128 to 127,
inclusive, and may cache other values outside of this range.
Parameters:
s - a short value.
Returns:
a Short instance representing s.
Since:
1.5
public static Short decode |
|
throws |
|
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 as defined in section {@jls 3.10.1} of
The Java Language Specification,
except that underscores are not accepted between digits.
The sequence of characters following an optional
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:
See Also:
Returns the value of this
Short as a
byte after
a narrowing primitive conversion.
Overrides:
Returns:
the numeric value represented by this object after conversion
to type byte.
public short shortValue |
() |
Returns the value of this
Short as a
short.
Overrides:
Returns:
the numeric value represented by this object after conversion
to type short.
Returns the value of this
Short as an
int after
a widening primitive conversion.
Overrides:
Returns:
the numeric value represented by this object after conversion
to type int.
Returns the value of this
Short as a
long after
a widening primitive conversion.
Overrides:
Returns:
the numeric value represented by this object after conversion
to type long.
public float floatValue |
() |
Returns the value of this
Short as a
float
after a widening primitive conversion.
Overrides:
Returns:
the numeric value represented by this object after conversion
to type float.
public double doubleValue |
() |
Returns the value of this
Short as a
double
after a widening primitive conversion.
Overrides:
Returns:
the numeric value represented by this object after conversion
to type double.
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.
Overrides:
Returns:
a string representation of the value of this object in
base 10.
Returns a hash code for this
Short; equal to the result
of invoking
intValue().
Overrides:
Returns:
a hash code value for this Short
See Also:
public static int hashCode |
(short value) |
Returns a hash code for a
short value; compatible with
Short.hashCode().
Parameters:
value - the value to hash
Returns:
a hash code value for a short value.
Since:
1.8
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:
Parameters:
obj - the object to compare with
Returns:
true if the objects are the same;
false otherwise.
See Also:
Compares two
Short objects numerically.
Specified by:
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
public static int compare |
(short x, short y) |
Compares two
short values numerically.
The value returned is identical to what would be returned by:
Short.valueOf(x).compareTo(Short.valueOf(y))
Parameters:
x - the first
short to compare
y - the second short to compare
Returns:
the value 0 if x == y;
a value less than 0 if x < y; and
a value greater than 0 if x > y
Since:
1.7
public static int compareUnsigned |
(short x, short y) |
Compares two
short values numerically treating the values
as unsigned.
Parameters:
x - the first
short to compare
y - the second short to compare
Returns:
the value 0 if x == y; a value less
than 0 if x < y as unsigned values; and
a value greater than 0 if x > y as
unsigned values
Since:
9
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.
Parameters:
i - the value whose bytes are to be reversed
Returns:
the value obtained by reversing (or, equivalently, swapping)
the bytes in the specified short value.
Since:
1.5
public static int toUnsignedInt |
(short x) |
Converts the argument to an
int by an unsigned
conversion. In an unsigned conversion to an
int, the
high-order 16 bits of the
int are zero and the
low-order 16 bits are equal to the bits of the
short argument.
Consequently, zero and positive
short values are mapped
to a numerically equal
int value and negative
short values are mapped to an
int value equal to the
input plus 2
16.
Parameters:
x - the value to convert to an unsigned int
Returns:
the argument converted to int by an unsigned
conversion
Since:
1.8
public static long toUnsignedLong |
(short x) |
Converts the argument to a
long by an unsigned
conversion. In an unsigned conversion to a
long, the
high-order 48 bits of the
long are zero and the
low-order 16 bits are equal to the bits of the
short argument.
Consequently, zero and positive
short values are mapped
to a numerically equal
long value and negative
short values are mapped to a
long value equal to the
input plus 2
16.
Parameters:
x - the value to convert to an unsigned long
Returns:
the argument converted to long by an unsigned
conversion
Since:
1.8
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz