java.lang.Integer Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.lang;
/**
* The Integer class wraps a value of the primitive type
* int in an object. An object of type
* Integer contains a single field whose type is
* int.
*
*
*
* In addition, this class provides several methods for converting an
* int to a String and a String
* to an int, as well as other constants and methods
* useful when dealing with an int.
*
* @author Lee Boynton
* @author Arthur van Hoff
* @version 1.67 11/10/00
* @since JDK1.0
*/
public final class Integer extends java.lang.Number
implements java.lang.Comparable
{
/**
* A constant holding the minimum value an int can
* have, -231.
*/
public static final int MIN_VALUE = -2147483648;
/**
* A constant holding the maximum value an int can
* have, 231-1.
*/
public static final int MAX_VALUE = 2147483647;
/**
* The Class instance representing the primitive type
* int.
*
* @since JDK1.1
*/
public static final java.lang.Class TYPE = null;
/**
* The value of the Integer.
*
* @serial
*/
private int value;
/**
* Constructs a newly allocated Integer object that
* represents the specified int value.
*
* @param value the value to be represented by the
* Integer object.
*/
public Integer(int value) { }
/**
* Constructs a newly allocated Integer object that
* represents the int value indicated by the
* String parameter. The string is converted to an
* int value in exactly the manner used by the
* parseInt method for radix 10.
*
* @param s the String to be converted to an
* Integer.
* @exception NumberFormatException if the String does not
* contain a parsable integer.
* @see java.lang.Integer#parseInt(java.lang.String, int)
*/
public Integer(java.lang.String s) throws java.lang.NumberFormatException
{ }
/**
* Returns a string representation of the first argument in the
* radix specified by the second argument.
*
* If the radix is smaller than Character.MIN_RADIX
* or larger than Character.MAX_RADIX, then the radix
* 10 is used instead.
*
* If the first argument is negative, the first element of the
* result is the ASCII minus character '-'
* ('\u002D'). If the first argument is not
* negative, no sign character appears in the result.
*
* The remaining characters of the result represent the magnitude
* of the first argument. If the magnitude is zero, it is
* represented by a single zero character '0'
* ('\u0030'); otherwise, the first character of
* the representation of the magnitude will not be the zero
* character. The following ASCII characters are used as digits:
*
* 0123456789abcdefghijklmnopqrstuvwxyz
*
* These are '\u0030' through
* '\u0039' and '\u0061' through
* '\u007A'. If radix is
* N, then the first N of these characters
* are used as radix-N digits in the order shown. Thus,
* the digits for hexadecimal (radix 16) are
* 0123456789abcdef. If uppercase letters are
* desired, the {@link java.lang.String#toUpperCase()} method may
* be called on the result:
*
* Integer.toString(n, 16).toUpperCase()
*
*
* @param i an integer to be converted to a string.
* @param radix the radix to use in the string representation.
* @return a string representation of the argument in the specified radix.
* @see java.lang.Character#MAX_RADIX
* @see java.lang.Character#MIN_RADIX
*/
public static java.lang.String toString(int i, int radix) {
return null;
}
/**
* Returns a string representation of the integer argument as an
* unsigned integer in base 16.
*
* The unsigned integer value is the argument plus 232
* if the argument is negative; otherwise, it is equal to the
* argument. This value is converted to a string of ASCII digits
* in hexadecimal (base 16) with no extra leading
* 0s. If the unsigned magnitude is zero, it is
* represented by a single zero character '0'
* ('\u0030'); otherwise, the first character of
* the representation of the unsigned magnitude will not be the
* zero character. The following characters are used as
* hexadecimal digits:
*
* 0123456789abcdef
*
* These are the characters '\u0030' through
* '\u0039' and '\u0061' through
* '\u0066'. If uppercase letters are
* desired, the {@link java.lang.String#toUpperCase()} method may
* be called on the result:
*
* Integer.toHexString(n).toUpperCase()
*
*
* @param i an integer to be converted to a string.
* @return the string representation of the unsigned integer value
* represented by the argument in hexadecimal (base 16).
* @since JDK1.0.2
*/
public static java.lang.String toHexString(int i) {
return null;
}
/**
* Returns a string representation of the integer argument as an
* unsigned integer in base 8.
*
* The unsigned integer value is the argument plus 232
* if the argument is negative; otherwise, it is equal to the
* argument. This value is converted to a string of ASCII digits
* in octal (base 8) with no extra leading 0s.
*
* If the unsigned magnitude is zero, it is represented by a
* single zero character '0'
* ('\u0030'); otherwise, the first character of
* the representation of the unsigned magnitude will not be the
* zero character. The following characters are used as octal
* digits:
*
* 01234567
*
* These are the characters '\u0030' through
* '\u0037'.
*
* @param i an integer to be converted to a string.
* @return the string representation of the unsigned integer value
* represented by the argument in octal (base 8).
* @since JDK1.0.2
*/
public static java.lang.String toOctalString(int i) {
return null;
}
/**
* Returns a string representation of the integer argument as an
* unsigned integer in base 2.
*
* The unsigned integer value is the argument plus 232
* if the argument is negative; otherwise it is equal to the
* argument. This value is converted to a string of ASCII digits
* in binary (base 2) with no extra leading 0s.
* If the unsigned magnitude is zero, it is represented by a
* single zero character '0'
* ('\u0030'); otherwise, the first character of
* the representation of the unsigned magnitude will not be the
* zero character. The characters '0'
* ('\u0030') and '1'
* ('\u0031') are used as binary digits.
*
* @param i an integer to be converted to a string.
* @return the string representation of the unsigned integer value
* represented by the argument in binary (base 2).
* @since JDK1.0.2
*/
public static java.lang.String toBinaryString(int i) {
return null;
}
/**
* Returns a String object representing the
* specified integer. The argument is converted to signed decimal
* representation and returned as a string, exactly as if the
* argument and radix 10 were given as arguments to the {@link
* #toString(int, int)} method.
*
* @param i an integer to be converted.
* @return a string representation of the argument in base 10.
*/
public static java.lang.String toString(int i) {
return null;
}
/**
* Parses the string argument as a signed integer 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 '-' ('\u002D') to
* indicate a negative value. The resulting integer 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
* {@link java.lang.Character#MIN_RADIX} or
* larger than {@link java.lang.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 type
*
int.
*
* Examples:
*
* parseInt("0", 10) returns 0
* parseInt("473", 10) returns 473
* parseInt("-0", 10) returns 0
* parseInt("-FF", 16) returns -255
* parseInt("1100110", 2) returns 102
* parseInt("2147483647", 10) returns 2147483647
* parseInt("-2147483648", 10) returns -2147483648
* parseInt("2147483648", 10) throws a NumberFormatException
* parseInt("99", 8) throws a NumberFormatException
* parseInt("Kona", 10) throws a NumberFormatException
* parseInt("Kona", 27) returns 411787
*
*
* @param s the String containing the integer
* representation to be parsed
* @param radix the radix to be used while parsing s.
* @return the integer represented by the string argument in the
* specified radix.
* @exception NumberFormatException if the String
* does not contain a parsable int.
*/
public static int parseInt(java.lang.String s, int radix)
throws java.lang.NumberFormatException
{
return 0;
}
/**
* Parses the string argument as a signed decimal integer. 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
* integer value is returned, exactly as if the argument and the radix
* 10 were given as arguments to the
* {@link #parseInt(java.lang.String, int)} method.
*
* @param s a String containing the int
* representation to be parsed
* @return the integer value represented by the argument in decimal.
* @exception NumberFormatException if the string does not contain a
* parsable integer.
*/
public static int parseInt(java.lang.String s)
throws java.lang.NumberFormatException
{
return 0;
}
/**
* Returns an Integer 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 integer in the radix
* specified by the second argument, exactly as if the arguments
* were given to the {@link #parseInt(java.lang.String, int)}
* method. The result is an Integer object that
* represents the integer value specified by the string.
*
* In other words, this method returns an Integer
* object equal to the value of:
*
*
* new Integer(Integer.parseInt(s, radix))
*
*
* @param s the string to be parsed.
* @param radix the radix to be used in interpreting s
* @return an Integer object holding the value
* represented by the string argument in the specified
* radix.
* @exception NumberFormatException if the String
* does not contain a parsable int.
*/
public static java.lang.Integer valueOf(java.lang.String s, int radix)
throws java.lang.NumberFormatException
{
return null;
}
/**
* Returns an Integer object holding the
* value of the specified String. The argument is
* interpreted as representing a signed decimal integer, exactly
* as if the argument were given to the {@link
* #parseInt(java.lang.String)} method. The result is an
* Integer object that represents the integer value
* specified by the string.
*
* In other words, this method returns an Integer
* object equal to the value of:
*
*
* new Integer(Integer.parseInt(s))
*
*
* @param s the string to be parsed.
* @return an Integer object holding the value
* represented by the string argument.
* @exception NumberFormatException if the string cannot be parsed
* as an integer.
*/
public static java.lang.Integer valueOf(java.lang.String s)
throws java.lang.NumberFormatException
{
return null;
}
/**
* Returns the value of this Integer as a
* byte.
*/
public byte byteValue() {
return ' ';
}
/**
* Returns the value of this Integer as a
* short.
*/
public short shortValue() {
return -1;
}
/**
* Returns the value of this Integer as an
* int.
*/
public int intValue() {
return 0;
}
/**
* Returns the value of this Integer as a
* long.
*/
public long longValue() {
return -1;
}
/**
* Returns the value of this Integer as a
* float.
*/
public float floatValue() {
return 0.0f;
}
/**
* Returns the value of this Integer as a
* double.
*/
public double doubleValue() {
return 0.0d;
}
/**
* Returns a String object representing this
* Integer's value. The value is converted to signed
* decimal representation and returned as a string, exactly as if
* the integer value were given as an argument to the {@link
* java.lang.Integer#toString(int)} method.
*
* @return a string representation of the value of this object in
* base 10.
*/
public java.lang.String toString() {
return null;
}
/**
* Returns a hash code for this Integer.
*
* @return a hash code value for this object, equal to the
* primitive int value represented by this
* Integer object.
*/
public int hashCode() {
return 0;
}
/**
* Compares this object to the specified object. The result is
* true if and only if the argument is not
* null and is an Integer object that
* contains the same int value as this object.
*
* @param obj the object to compare with.
* @return true if the objects are the same;
* false otherwise.
*/
public boolean equals(java.lang.Object obj) {
return false;
}
/**
* Determines the integer value of the system property with the
* specified name.
*
* The first argument is treated as the name of a system property.
* System properties are accessible through the
* {@link java.lang.System#getProperty(java.lang.String)} method. The
* string value of this property is then interpreted as an integer
* value and an Integer object representing this value is
* returned. Details of possible numeric formats can be found with
* the definition of getProperty.
*
* If there is no property with the specified name, if the specified name
* is empty or null, or if the property does not have
* the correct numeric format, then null is returned.
*
* In other words, this method returns an Integer
* object equal to the value of:
*
*
* getInteger(nm, null)
*
*
* @param nm property name.
* @return the Integer value of the property.
* @see java.lang.System#getProperty(java.lang.String)
* @see java.lang.System#getProperty(java.lang.String, java.lang.String)
*/
public static java.lang.Integer getInteger(java.lang.String nm) {
return null;
}
/**
* Determines the integer value of the system property with the
* specified name.
*
* The first argument is treated as the name of a system property.
* System properties are accessible through the {@link
* java.lang.System#getProperty(java.lang.String)} method. The
* string value of this property is then interpreted as an integer
* value and an Integer object representing this value is
* returned. Details of possible numeric formats can be found with
* the definition of getProperty.
*
* The second argument is the default value. An Integer object
* that represents the value of the second argument is returned if there
* is no property of the specified name, if the property does not have
* the correct numeric format, or if the specified name is empty or
* null.
*
* In other words, this method returns an Integer object
* equal to the value of:
*
* getInteger(nm, new Integer(val))
*
* but in practice it may be implemented in a manner such as:
*
* Integer result = getInteger(nm, null);
* return (result == null) ? new Integer(val) : result;
*
* to avoid the unnecessary allocation of an Integer
* object when the default value is not needed.
*
* @param nm property name.
* @param val default value.
* @return the Integer value of the property.
* @see java.lang.System#getProperty(java.lang.String)
* @see java.lang.System#getProperty(java.lang.String, java.lang.String)
*/
public static java.lang.Integer getInteger(java.lang.String nm, int val) {
return null;
}
/**
* Returns the integer value of the system property with the
* specified name. The first argument is treated as the name of a
* system property. System properties are accessible through the
* {@link java.lang.System#getProperty(java.lang.String)} method.
* The string value of this property is then interpreted as an
* integer value, as per the Integer.decode method,
* and an Integer object representing this value is
* returned.
*
*
- If the property value begins with the two ASCII characters
*
0x or the ASCII character #, not
* followed by a minus sign, then the rest of it is parsed as a
* hexadecimal integer exactly as by the method
* {@link #valueOf(java.lang.String, int)} with radix 16.
* - If the property value begins with the ASCII character
*
0 followed by another character, it is parsed as an
* octal integer exactly as by the method
* {@link #valueOf(java.lang.String, int)} with radix 8.
* - Otherwise, the property value is parsed as a decimal integer
* exactly as by the method {@link #valueOf(java.lang.String, int)}
* with radix 10.
*
* The second argument is the default value. The default value is
* returned if there is no property of the specified name, if the
* property does not have the correct numeric format, or if the
* specified name is empty or null.
*
* @param nm property name.
* @param val default value.
* @return the Integer value of the property.
* @see java.lang.System#getProperty(java.lang.String)
* @see java.lang.System#getProperty(java.lang.String, java.lang.String)
* @see java.lang.Integer#decode
*/
public static java.lang.Integer getInteger(java.lang.String nm,
java.lang.Integer val)
{
return null;
}
/**
* Decodes a String into an Integer.
* Accepts decimal, hexadecimal, and octal numbers 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 Integer.parseInt
* 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 String is the
* minus sign. No whitespace characters are permitted in the
* String.
*
* @param nm the String to decode.
* @return a Integer object holding the int
* value represented by nm
* @exception NumberFormatException if the String does not
* contain a parsable integer.
* @see java.lang.Integer#parseInt(java.lang.String, int)
* @since 1.2
*/
public static java.lang.Integer decode(java.lang.String nm)
throws java.lang.NumberFormatException
{
return null;
}
/**
* Compares two Integer objects numerically.
*
* @param anotherInteger the Integer to be compared.
* @return the value 0 if this Integer is
* equal to the argument Integer; a value less than
* 0 if this Integer is numerically less
* than the argument Integer; and a value greater
* than 0 if this Integer is numerically
* greater than the argument Integer (signed
* comparison).
* @since 1.2
*/
public int compareTo(java.lang.Integer anotherInteger) {
return 0;
}
/**
* Compares this Integer object to another object.
* If the object is an Integer, this function behaves
* like compareTo(Integer). Otherwise, it throws a
* ClassCastException (as Integer
* objects are only comparable to other Integer
* objects).
*
* @param o the Object to be compared.
* @return the value 0 if the argument is a
* Integer numerically equal to this
* Integer; a value less than 0
* if the argument is a Integer numerically
* greater than this Integer; and a value
* greater than 0 if the argument is a
* Integer numerically less than this
* Integer.
* @exception ClassCastException if the argument is not an
* Integer.
* @see java.lang.Comparable
* @since 1.2
*/
public int compareTo(java.lang.Object o) {
return 0;
}
/** use serialVersionUID from JDK 1.0.2 for interoperability */
private static final long serialVersionUID = 1360826667806852920L;
}