/*
* @(#)Short.java 1.29 06/10/10
*
* Copyright 1990-2008 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version
* 2 only, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License version 2 for more details (a copy is
* included at /legal/license.txt).
*
* You should have received a copy of the GNU General Public License
* version 2 along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.com if you need additional
* information or have any questions.
*
*/
package java.lang;
/**
* The <code>Short</code> class wraps a value of primitive type
* <code>short</code> in an object. An object of type
* <code>Short</code> contains a single field whose type is
* <code>short</code>.
*
* <p>
*
* In addition, this class provides several methods for converting a
* <code>short</code> to a <code>String</code> and a
* <code>String</code> to a <code>short</code>, as well as other
* constants and methods useful when dealing with a <code>short</code>.
*
* @author Nakul Saraiya
* @version 1.33, 01/23/03
* @see java.lang.Number
* @since JDK1.1
*/
public final class Short extends Number implements Comparable {
/**
* A constant holding the minimum value a <code>short</code> can
* have, -2<sup>15</sup>.
*/
public static final short MIN_VALUE = -32768;
/**
* A constant holding the maximum value a <code>short</code> can
* have, 2<sup>15</sup>-1.
*/
public static final short MAX_VALUE = 32767;
/**
* The <code>Class</code> instance representing the primitive type
* <code>short</code>.
*/
public static final Class TYPE = Class.getPrimitiveClass("short");
/**
* Returns a new <code>String</code> object representing the
* specified <code>short</code>. The radix is assumed to be 10.
*
* @param s the <code>short</code> to be converted
* @return the string representation of the specified <code>short</code>
* @see java.lang.Integer#toString(int)
*/
public static String toString(short s) {
return Integer.toString((int)s, 10);
}
/**
* Parses the string argument as a signed decimal
* <code>short</code>. The characters in the string must all be
* decimal digits, except that the first character may be an ASCII
* minus sign <code>'-'</code> (<code>'\u002D'</code>) to
* indicate a negative value. The resulting <code>short</code> value is
* returned, exactly as if the argument and the radix 10 were
* given as arguments to the {@link #parseShort(java.lang.String,
* int)} method.
*
* @param s a <code>String</code> containing the <code>short</code>
* representation to be parsed
* @return the <code>short</code> value represented by the
* argument in decimal.
* @exception NumberFormatException If the string does not
* contain a parsable <code>short</code>.
*/
public static short parseShort(String s) throws NumberFormatException {
return parseShort(s, 10);
}
/**
* Parses the string argument as a signed <code>short</code> 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 {@link java.lang.Character#digit(char,
* int)} returns a nonnegative value) except that the first
* character may be an ASCII minus sign <code>'-'</code>
* (<code>'\u002D'</code>) to indicate a negative value. The
* resulting <code>byte</code> value is returned.
* <p>
* An exception of type <code>NumberFormatException</code> is
* thrown if any of the following situations occurs:
* <ul>
* <li> The first argument is <code>null</code> or is a string of
* length zero.
*
* <li> The radix is either smaller than {@link
* java.lang.Character#MIN_RADIX} or larger than {@link
* java.lang.Character#MAX_RADIX}.
*
* <li> Any character of the string is not a digit of the specified
* radix, except that the first character may be a minus sign
* <code>'-'</code> (<code>'\u002D'</code>) provided that the
* string is longer than length 1.
*
* <li> The value represented by the string is not a value of type
* <code>short</code>.
* </ul>
*
* @param s the <code>String</code> containing the
* <code>short</code> representation to be parsed
* @param radix the radix to be used while parsing <code>s</code>
* @return the <code>short</code> represented by the string
* argument in the specified radix.
* @exception NumberFormatException If the <code>String</code>
* does not contain a parsable <code>short</code>.
*/
public static short parseShort(String s, int radix)
throws NumberFormatException {
int i = Integer.parseInt(s, radix);
if (i < MIN_VALUE || i > MAX_VALUE)
throw new NumberFormatException(
"Value out of range. Value:\"" + s + "\" Radix:" + radix);
return (short)i;
}
/**
* Returns a <code>Short</code> object holding the value
* extracted from the specified <code>String</code> when parsed
* with the radix given by the second argument. The first argument
* is interpreted as representing a signed <code>short</code> in
* the radix specified by the second argument, exactly as if the
* argument were given to the {@link #parseShort(java.lang.String,
* int)} method. The result is a <code>Short</code> object that
* represents the <code>short</code> value specified by the string.
* <p> In other words, this method returns a <code>Short</code> object
* equal to the value of:
*
* <blockquote><code>
* new Short(Short.parseShort(s, radix))
* </code></blockquote>
*
* @param s the string to be parsed
* @param radix the radix to be used in interpreting <code>s</code>
* @return a <code>Short</code> object holding the value
* represented by the string argument in the
* specified radix.
* @exception NumberFormatException If the <code>String</code> does
* not contain a parsable <code>short</code>.
*/
public static Short valueOf(String s, int radix)
throws NumberFormatException {
return new Short(parseShort(s, radix));
}
/**
* Returns a <code>Short</code> object holding the
* value given by the specified <code>String</code>. The argument
* is interpreted as representing a signed decimal
* <code>short</code>, exactly as if the argument were given to
* the {@link #parseShort(java.lang.String)} method. The result is
* a <code>Short</code> object that represents the
* <code>short</code> value specified by the string. <p> In other
* words, this method returns a <code>Byte</code> object equal to
* the value of:
*
* <blockquote><code>
* new Short(Short.parseShort(s))
* </code></blockquote>
*
* @param s the string to be parsed
* @return a <code>Short</code> object holding the value
* represented by the string argument
* @exception NumberFormatException If the <code>String</code> does
* not contain a parsable <code>short</code>.
*/
public static Short valueOf(String s) throws NumberFormatException {
return valueOf(s, 10);
}
/**
* Decodes a <code>String</code> into a <code>Short</code>.
* Accepts decimal, hexadecimal, and octal numbers given by
* the following grammar:
*
* <blockquote>
* <dl>
* <dt><i>DecodableString:</i>
* <dd><i>Sign<sub>opt</sub> DecimalNumeral</i>
* <dd><i>Sign<sub>opt</sub></i> <code>0x</code> <i>HexDigits</i>
* <dd><i>Sign<sub>opt</sub></i> <code>0X</code> <i>HexDigits</i>
* <dd><i>Sign<sub>opt</sub></i> <code>#</code> <i>HexDigits</i>
* <dd><i>Sign<sub>opt</sub></i> <code>0</code> <i>OctalDigits</i>
* <p>
* <dt><i>Sign:</i>
* <dd><code>-</code>
* </dl>
* </blockquote>
*
* <i>DecimalNumeral</i>, <i>HexDigits</i>, and <i>OctalDigits</i>
* are defined in <a href="http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#48282">§3.10.1</a>
* of the <a href="http://java.sun.com/docs/books/jls/html/">Java
* Language Specification</a>.
* <p>
* The sequence of characters following an (optional) negative
* sign and/or radix specifier ("<code>0x</code>",
* "<code>0X</code>", "<code>#</code>", or
* leading zero) is parsed as by the <code>Short.parseShort</code>
* method with the indicated radix (10, 16, or 8). This sequence
* of characters must represent a positive value or a {@link
* NumberFormatException} will be thrown. The result is negated
* if first character of the specified <code>String</code> is the
* minus sign. No whitespace characters are permitted in the
* <code>String</code>.
*
* @param nm the <code>String</code> to decode.
* @return a <code>Short</code> object holding the <code>short</code>
* value represented by <code>nm</code>
* @exception NumberFormatException if the <code>String</code> does not
* contain a parsable <code>short</code>.
* @see java.lang.Short#parseShort(java.lang.String, int)
*/
public static Short decode(String nm) throws NumberFormatException {
int radix = 10;
int index = 0;
boolean negative = false;
Short result;
// Handle minus sign, if present
if (nm.startsWith("-")) {
negative = true;
index++;
}
// Handle radix specifier, if present
if (nm.startsWith("0x", index) || nm.startsWith("0X", index)) {
index += 2;
radix = 16;
}
else if (nm.startsWith("#", index)) {
index ++;
radix = 16;
}
else if (nm.startsWith("0", index) && nm.length() > 1 + index) {
index ++;
radix = 8;
}
if (nm.startsWith("-", index))
throw new NumberFormatException("Negative sign in wrong position");
try {
result = Short.valueOf(nm.substring(index), radix);
result = negative ? new Short((short)-result.shortValue()) :result;
} catch (NumberFormatException e) {
// If number is Short.MIN_VALUE, we'll end up here. The next line
// handles this case, and causes any genuine format error to be
// rethrown.
String constant = negative ? new String("-" + nm.substring(index))
: nm.substring(index);
result = Short.valueOf(constant, radix);
}
return result;
}
/**
* The value of the <code>Short</code>.
*
* @serial
*/
private short value;
/**
* Constructs a newly allocated <code>Short</code> object that
* represents the specified <code>short</code> value.
*
* @param value the value to be represented by the
* <code>Short</code>.
*/
public Short(short value) {
this.value = value;
}
/**
* Constructs a newly allocated <code>Short</code> object that
* represents the <code>short</code> value indicated by the
* <code>String</code> parameter. The string is converted to a
* <code>short</code> value in exactly the manner used by the
* <code>parseShort</code> method for radix 10.
*
* @param s the <code>String</code> to be converted to a
* <code>Short</code>
* @exception NumberFormatException If the <code>String</code>
* does not contain a parsable <code>short</code>.
* @see java.lang.Short#parseShort(java.lang.String, int)
*/
public Short(String s) throws NumberFormatException {
this.value = parseShort(s, 10);
}
/**
* Returns the value of this <code>Short</code> as a
* <code>byte</code>.
*/
public byte byteValue() {
return (byte)value;
}
/**
* Returns the value of this <code>Short</code> as a
* <code>short</code>.
*/
public short shortValue() {
return value;
}
/**
* Returns the value of this <code>Short</code> as an
* <code>int</code>.
*/
public int intValue() {
return (int)value;
}
/**
* Returns the value of this <code>Short</code> as a
* <code>long</code>.
*/
public long longValue() {
return (long)value;
}
/**
* Returns the value of this <code>Short</code> as a
* <code>float</code>.
*/
public float floatValue() {
return (float)value;
}
/**
* Returns the value of this <code>Short</code> as a
* <code>double</code>.
*/
public double doubleValue() {
return (double)value;
}
/**
* Returns a <code>String</code> object representing this
* <code>Short</code>'s value. The value is converted to signed
* decimal representation and returned as a string, exactly as if
* the <code>short</code> value were given as an argument to the
* {@link java.lang.Short#toString(short)} method.
*
* @return a string representation of the value of this object in
* base 10.
*/
public String toString() {
return String.valueOf((int)value);
}
/**
* Returns a hash code for this <code>Short</code>.
*/
public int hashCode() {
return (int)value;
}
/**
* Compares this object to the specified object. The result is
* <code>true</code> if and only if the argument is not
* <code>null</code> and is a <code>Short</code> object that
* contains the same <code>short</code> value as this object.
*
* @param obj the object to compare with
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
*/
public boolean equals(Object obj) {
if (obj instanceof Short) {
return value == ((Short)obj).shortValue();
}
return false;
}
/**
* Compares two <code>Short</code> objects numerically.
*
* @param anotherShort the <code>Short</code> to be compared.
* @return the value <code>0</code> if this <code>Short</code> is
* equal to the argument <code>Short</code>; a value less than
* <code>0</code> if this <code>Short</code> is numerically less
* than the argument <code>Short</code>; and a value greater than
* <code>0</code> if this <code>Short</code> is numerically
* greater than the argument <code>Short</code> (signed
* comparison).
* @since 1.2
*/
public int compareTo(Short anotherShort) {
return this.value - anotherShort.value;
}
/**
* Compares this <code>Short</code> object to another object. If
* the object is a <code>Short</code>, this function behaves like
* <code>compareTo(Short)</code>. Otherwise, it throws a
* <code>ClassCastException</code> (as <code>Short</code> objects
* are only comparable to other <code>Short</code> objects).
*
* @param o the <code>Object</code> to be compared.
* @return the value <code>0</code> if the argument is a
* <code>Short</code> numerically equal to this
* <code>Short</code>; a value less than <code>0</code> if
* the argument is a <code>Short</code> numerically greater
* than this <code>Short</code>; and a value greater than
* <code>0</code> if the argument is a <code>Short</code>
* numerically less than this <code>Short</code>.
* @exception <code>ClassCastException</code> if the argument is not a
* <code>Short</code>.
* @see java.lang.Comparable
* @since 1.2
*/
public int compareTo(Object o) {
return compareTo((Short)o);
}
/** use serialVersionUID from JDK 1.1. for interoperability */
private static final long serialVersionUID = 7515723908773894738L;
}