java.lang.Short Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package java.lang;
/**
* The wrapper for the primitive type {@code short}.
*
* @see java.lang.Number
* @since 1.1
*/
@FindBugsSuppressWarnings("DM_NUMBER_CTOR")
public final class Short extends Number implements Comparable {
private static final long serialVersionUID = 7515723908773894738L;
/**
* The value which the receiver represents.
*/
private final short value;
/**
* Constant for the maximum {@code short} value, 215-1.
*/
public static final short MAX_VALUE = (short) 0x7FFF;
/**
* Constant for the minimum {@code short} value, -215.
*/
public static final short MIN_VALUE = (short) 0x8000;
/**
* Constant for the number of bits needed to represent a {@code short} in
* two's complement form.
*
* @since 1.5
*/
public static final int SIZE = 16;
/**
* The {@link Class} object that represents the primitive type {@code
* short}.
*/
@SuppressWarnings("unchecked")
public static final Class TYPE
= (Class) short[].class.getComponentType();
// Note: Short.TYPE can't be set to "short.class", since *that* is
// defined to be "java.lang.Short.TYPE";
/**
* Constructs a new {@code Short} from the specified string.
*
* @param string
* the string representation of a short value.
* @throws NumberFormatException
* if {@code string} cannot be parsed as a short value.
* @see #parseShort(String)
*/
public Short(String string) throws NumberFormatException {
this(parseShort(string));
}
/**
* Constructs a new {@code Short} with the specified primitive short value.
*
* @param value
* the primitive short value to store in the new instance.
*/
public Short(short value) {
this.value = value;
}
@Override
public byte byteValue() {
return (byte) value;
}
/**
* Compares this object to the specified short object to determine their
* relative order.
*
* @param object
* the short object to compare this object to.
* @return a negative value if the value of this short is less than the
* value of {@code object}; 0 if the value of this short and the
* value of {@code object} are equal; a positive value if the value
* of this short is greater than the value of {@code object}.
* @throws NullPointerException
* if {@code object} is null.
* @see java.lang.Comparable
* @since 1.2
*/
public int compareTo(Short object) {
return compare(value, object.value);
}
/**
* Compares two {@code short} values.
* @return 0 if lhs = rhs, less than 0 if lhs < rhs, and greater than 0 if lhs > rhs.
* @since 1.7
*/
public static int compare(short lhs, short rhs) {
return lhs > rhs ? 1 : (lhs < rhs ? -1 : 0);
}
/**
* Parses the specified string and returns a {@code 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.
*
* @param string
* a string representation of a short value.
* @return a {@code Short} containing the value represented by
* {@code string}.
* @throws NumberFormatException
* if {@code string} cannot be parsed as a short value.
*/
public static Short decode(String string) throws NumberFormatException {
int intValue = Integer.decode(string).intValue();
short result = (short) intValue;
if (result == intValue) {
return valueOf(result);
}
throw new NumberFormatException("Value out of range for short: \"" + string + "\"");
}
@Override
public double doubleValue() {
return value;
}
/**
* Compares this instance with the specified object and indicates if they
* are equal. In order to be equal, {@code object} must be an instance of
* {@code Short} and have the same short value as this object.
*
* @param object
* the object to compare this short with.
* @return {@code true} if the specified object is equal to this
* {@code Short}; {@code false} otherwise.
*/
@Override
public boolean equals(Object object) {
return (object instanceof Short) && (((Short) object).value == value);
}
@Override
public float floatValue() {
return value;
}
@Override
public int hashCode() {
return value;
}
@Override
public int intValue() {
return value;
}
@Override
public long longValue() {
return value;
}
/**
* Parses the specified string as a signed decimal short value. The ASCII
* character \u002d ('-') is recognized as the minus sign.
*
* @param string
* the string representation of a short value.
* @return the primitive short value represented by {@code string}.
* @throws NumberFormatException
* if {@code string} cannot be parsed as a short value.
*/
public static short parseShort(String string) throws NumberFormatException {
return parseShort(string, 10);
}
/**
* Parses the specified string as a signed short value using the specified
* radix. The ASCII character \u002d ('-') is recognized as the minus sign.
*
* @param string
* the string representation of a short value.
* @param radix
* the radix to use when parsing.
* @return the primitive short value represented by {@code string} using
* {@code radix}.
* @throws NumberFormatException
* if {@code string} cannot be parsed as a short value, or
* {@code radix < Character.MIN_RADIX ||
* radix > Character.MAX_RADIX}.
*/
public static short parseShort(String string, int radix) throws NumberFormatException {
int intValue = Integer.parseInt(string, radix);
short result = (short) intValue;
if (result == intValue) {
return result;
}
throw new NumberFormatException("Value out of range for short: \"" + string + "\"");
}
/**
* Gets the primitive value of this short.
*
* @return this object's primitive value.
*/
@Override
public short shortValue() {
return value;
}
@Override
public String toString() {
return Integer.toString(value);
}
/**
* Returns a string containing a concise, human-readable description of the
* specified short value with radix 10.
*
* @param value
* the short to convert to a string.
* @return a printable representation of {@code value}.
*/
public static String toString(short value) {
return Integer.toString(value);
}
/**
* Parses the specified string as a signed decimal short value.
*
* @param string
* the string representation of a short value.
* @return a {@code Short} instance containing the short value represented
* by {@code string}.
* @throws NumberFormatException
* if {@code string} cannot be parsed as a short value.
* @see #parseShort(String)
*/
public static Short valueOf(String string) throws NumberFormatException {
return valueOf(parseShort(string));
}
/**
* Parses the specified string as a signed short value using the specified
* radix.
*
* @param string
* the string representation of a short value.
* @param radix
* the radix to use when parsing.
* @return a {@code Short} instance containing the short value represented
* by {@code string} using {@code radix}.
* @throws NumberFormatException
* if {@code string} cannot be parsed as a short value, or
* {@code radix < Character.MIN_RADIX ||
* radix > Character.MAX_RADIX}.
* @see #parseShort(String, int)
*/
public static Short valueOf(String string, int radix) throws NumberFormatException {
return valueOf(parseShort(string, radix));
}
/**
* Reverses the bytes of the specified short.
*
* @param s
* the short value for which to reverse bytes.
* @return the reversed value.
* @since 1.5
*/
public static short reverseBytes(short s) {
return (short) ((s << 8) | ((s >>> 8) & 0xFF));
}
/**
* Returns a {@code Short} instance for the specified short value.
*
* If it is not necessary to get a new {@code 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.
*
* @param s
* the short value to store in the instance.
* @return a {@code Short} instance containing {@code s}.
* @since 1.5
*/
public static Short valueOf(short s) {
return s < -128 || s >= 128 ? new Short(s) : SMALL_VALUES[s + 128];
}
/**
* A cache of instances used by {@link Short#valueOf(short)} and auto-boxing.
*/
private static final Short[] SMALL_VALUES = new Short[256];
static {
for (int i = -128; i < 128; i++) {
SMALL_VALUES[i + 128] = new Short((short) i);
}
}
}