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

java.lang

Class Long

java.lang.Object java.lang.Number java.lang.Long

All Implemented Interfaces:

Serializable, Comparable<Long>

public final class Long

extends Number

implements Comparable<Long>

The Long class wraps a value of the primitive typelong in an object. An object of type Long contains a single field whose type is long.

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

Implementation note: The implementations of the "bit twiddling" methods (such as highestOneBit andnumberOfTrailingZeros) are based on material from Henry S. Warren, Jr.'s Hacker's Delight, (Addison Wesley, 2002).

Since:

JDK1.0

See Also:

Serialized Form

MIN_VALUE

public static final long MIN_VALUE

A constant holding the minimum value a long can have, -263.

See Also:

Constant Field Values

MAX_VALUE

public static final long MAX_VALUE

A constant holding the maximum value a long can have, 263-1.

See Also:

Constant Field Values

TYPE

public static final Class<Long> TYPE

The Class instance representing the primitive typelong.

Since:

JDK1.1

SIZE

public static final int SIZE

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

Since:

1.5

See Also:

Constant Field Values

Long

public Long(long value)

Constructs a newly allocated Long object that represents the specified long argument.

Parameters:

value - the value to be represented by the Long object.

Long

public Long(String s) throws NumberFormatException

Constructs a newly allocated Long object that represents the long value indicated by theString parameter. The string is converted to along value in exactly the manner used by theparseLong method for radix 10.

Parameters:

s - the String to be converted to a Long.

Throws:

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

See Also:

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

toString

public static String toString(long i, int radix)

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 radix10 is used instead.

If the first argument is negative, the first element of the result is the ASCII minus sign '-' ('\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 isN, then the first N of these characters are used as radix-N digits in the order shown. Thus, the digits for hexadecimal (radix 16) are0123456789abcdef. If uppercase letters are desired, the String.toUpperCase() method may be called on the result:

Long.toString(n, 16).toUpperCase()

Parameters:

i - a longto be converted to a string.

radix - the radix to use in the string representation.

Returns:

a string representation of the argument in the specified radix.

See Also:

Character.MAX_RADIX, Character.MIN_RADIX

toHexString

public static String toHexString(long i)

Returns a string representation of the long argument as an unsigned integer in base 16.

The unsigned long value is the argument plus 264 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 String.toUpperCase() method may be called on the result:

Long.toHexString(n).toUpperCase()

Parameters:

i - a long to be converted to a string.

Returns:

the string representation of the unsigned long value represented by the argument in hexadecimal (base 16).

Since:

JDK 1.0.2

toOctalString

public static String toOctalString(long i)

Returns a string representation of the long argument as an unsigned integer in base 8.

The unsigned long value is the argument plus 264 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 leading0s.

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

Parameters:

i - a long to be converted to a string.

Returns:

the string representation of the unsigned long value represented by the argument in octal (base 8).

Since:

JDK 1.0.2

toBinaryString

public static String toBinaryString(long i)

Returns a string representation of the long argument as an unsigned integer in base 2.

The unsigned long value is the argument plus 264 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 leading0s. 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.

Parameters:

i - a long to be converted to a string.

Returns:

the string representation of the unsigned long value represented by the argument in binary (base 2).

Since:

JDK 1.0.2

toString

public static String toString(long i)

Returns a String object representing the specifiedlong. The argument is converted to signed decimal representation and returned as a string, exactly as if the argument and the radix 10 were given as arguments to the [toString(long, int)](../../java/lang/Long.html#toString%28long, int%29) method.

Parameters:

i - a long to be converted.

Returns:

a string representation of the argument in base 10.

parseLong

public static long parseLong(String s, int radix) throws NumberFormatException

Parses the string argument as a signed long 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 long value is returned.

Note that neither the character L ('\u004C') nor l ('\u006C') is permitted to appear at the end of the string as a type indicator, as would be permitted in Java programming language source code - except that eitherL or l may appear as a digit for a radix greater than 22.

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

Examples:

parseLong("0", 10) returns 0L parseLong("473", 10) returns 473L parseLong("-0", 10) returns 0L parseLong("-FF", 16) returns -255L parseLong("1100110", 2) returns 102L parseLong("99", 8) throws a NumberFormatException parseLong("Hazelnut", 10) throws a NumberFormatException parseLong("Hazelnut", 36) returns 1356099454469L

Parameters:

s - the String containing thelong representation to be parsed.

radix - the radix to be used while parsing s.

Returns:

the long 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 long.

parseLong

public static long parseLong(String s) throws NumberFormatException

Parses the string argument as a signed decimallong. 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 long value is returned, exactly as if the argument and the radix10 were given as arguments to the [parseLong(java.lang.String, int)](../../java/lang/Long.html#parseLong%28java.lang.String, int%29) method.

Note that neither the character L ('\u004C') nor l ('\u006C') is permitted to appear at the end of the string as a type indicator, as would be permitted in Java programming language source code.

Parameters:

s - a String containing the long representation to be parsed

Returns:

the long represented by the argument in decimal.

Throws:

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

valueOf

public static Long valueOf(String s, int radix) throws NumberFormatException

Returns a Long 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 signedlong in the radix specified by the second argument, exactly as if the arguments were given to the [parseLong(java.lang.String, int)](../../java/lang/Long.html#parseLong%28java.lang.String, int%29) method. The result is aLong object that represents the long value specified by the string.

In other words, this method returns a Long object equal to the value of:

new Long(Long.parseLong(s, radix))

Parameters:

s - the string to be parsed

radix - the radix to be used in interpreting s

Returns:

a Long 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 long.

valueOf

public static Long valueOf(String s) throws NumberFormatException

Returns a Long object holding the value of the specified String. The argument is interpreted as representing a signed decimal long, exactly as if the argument were given to the parseLong(java.lang.String) method. The result is aLong object that represents the integer value specified by the string.

In other words, this method returns a Long object equal to the value of:

new Long(Long.parseLong(s))

Parameters:

s - the string to be parsed.

Returns:

a Long object holding the value represented by the string argument.

Throws:

[NumberFormatException](../../java/lang/NumberFormatException.html "class in java.lang") - If the string cannot be parsed as a long.

valueOf

public static Long valueOf(long l)

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

Parameters:

l - a long value.

Returns:

a Long instance representing l.

Since:

1.5

decode

public static Long decode(String nm) throws NumberFormatException

Decodes a String into a Long. 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 Long.parseLong 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 Long object holding the long value represented by nm

Throws:

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

Since:

1.2

See Also:

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

byteValue

public byte byteValue()

Returns the value of this Long 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 Long 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 Long 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 Long as along value.

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 Long 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 Long 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 thisLong's value. The value is converted to signed decimal representation and returned as a string, exactly as if the long value were given as an argument to thetoString(long) 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 Long. The result is the exclusive OR of the two halves of the primitivelong value held by this Long object. That is, the hashcode is the value of the expression:

(int)(this.longValue()^(this.longValue()>>>32))

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 Long object that contains the same long 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

getLong

public static Long getLong(String nm)

Determines the long 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 System.getProperty(java.lang.String) method. The string value of this property is then interpreted as along value and a Long object representing this value is returned. Details of possible numeric formats can be found with the definition ofgetProperty.

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, thennull is returned.

In other words, this method returns a Long object equal to the value of:

getLong(nm, null)

Parameters:

nm - property name.

Returns:

the Long value of the property.

See Also:

System.getProperty(java.lang.String), [System.getProperty(java.lang.String, java.lang.String)](../../java/lang/System.html#getProperty%28java.lang.String, java.lang.String%29)

getLong

public static Long getLong(String nm, long val)

Determines the long 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 System.getProperty(java.lang.String) method. The string value of this property is then interpreted as along value and a Long object representing this value is returned. Details of possible numeric formats can be found with the definition ofgetProperty.

The second argument is the default value. A Long 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 a Long object equal to the value of:

getLong(nm, new Long(val))

but in practice it may be implemented in a manner such as:

Long result = getLong(nm, null); return (result == null) ? new Long(val) : result;

to avoid the unnecessary allocation of a Long object when the default value is not needed.

Parameters:

nm - property name.

val - default value.

Returns:

the Long value of the property.

See Also:

System.getProperty(java.lang.String), [System.getProperty(java.lang.String, java.lang.String)](../../java/lang/System.html#getProperty%28java.lang.String, java.lang.String%29)

getLong

public static Long getLong(String nm, Long val)

Returns the long 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 System.getProperty(java.lang.String) method. The string value of this property is then interpreted as a long value, as per theLong.decode method, and a Long object representing this value is returned.

• If the property value begins with the two ASCII characters0x or the ASCII character #, not followed by a minus sign, then the rest of it is parsed as a hexadecimal integer exactly as for the method [valueOf(java.lang.String, int)](../../java/lang/Long.html#valueOf%28java.lang.String, int%29) with radix 16.
• If the property value begins with the ASCII character0 followed by another character, it is parsed as an octal integer exactly as by the method [valueOf(java.lang.String, int)](../../java/lang/Long.html#valueOf%28java.lang.String, int%29) with radix 8.
• Otherwise the property value is parsed as a decimal integer exactly as by the method [valueOf(java.lang.String, int)](../../java/lang/Long.html#valueOf%28java.lang.String, int%29) with radix 10.

Note that, in every case, neither L ('\u004C') nor l ('\u006C') is permitted to appear at the end of the property value as a type indicator, as would be permitted in Java programming language source code.

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.

Parameters:

nm - property name.

val - default value.

Returns:

the Long value of the property.

See Also:

System.getProperty(java.lang.String), [System.getProperty(java.lang.String, java.lang.String)](../../java/lang/System.html#getProperty%28java.lang.String, java.lang.String%29), decode(java.lang.String)

compareTo

public int compareTo(Long anotherLong)

Compares two Long objects numerically.

Specified by:

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

Parameters:

anotherLong - the Long to be compared.

Returns:

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

Since:

1.2

highestOneBit

public static long highestOneBit(long i)

Returns an long value with at most a single one-bit, in the position of the highest-order ("leftmost") one-bit in the specifiedlong value. Returns zero if the specified value has no one-bits in its two's complement binary representation, that is, if it is equal to zero.

Returns:

an long value with a single one-bit, in the position of the highest-order one-bit in the specified value, or zero if the specified value is itself equal to zero.

Since:

1.5

lowestOneBit

public static long lowestOneBit(long i)

Returns an long value with at most a single one-bit, in the position of the lowest-order ("rightmost") one-bit in the specifiedlong value. Returns zero if the specified value has no one-bits in its two's complement binary representation, that is, if it is equal to zero.

Returns:

an long value with a single one-bit, in the position of the lowest-order one-bit in the specified value, or zero if the specified value is itself equal to zero.

Since:

1.5

numberOfLeadingZeros

public static int numberOfLeadingZeros(long i)

Returns the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified long value. Returns 64 if the specified value has no one-bits in its two's complement representation, in other words if it is equal to zero.

Note that this method is closely related to the logarithm base 2. For all positive long values x:

• floor(log2(x)) = 63 - numberOfLeadingZeros(x)
• ceil(log2(x)) = 64 - numberOfLeadingZeros(x - 1)

Returns:

the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified long value, or 64 if the value is equal to zero.

Since:

1.5

numberOfTrailingZeros

public static int numberOfTrailingZeros(long i)

Returns the number of zero bits following the lowest-order ("rightmost") one-bit in the two's complement binary representation of the specifiedlong value. Returns 64 if the specified value has no one-bits in its two's complement representation, in other words if it is equal to zero.

Returns:

the number of zero bits following the lowest-order ("rightmost") one-bit in the two's complement binary representation of the specified long value, or 64 if the value is equal to zero.

Since:

1.5

bitCount

public static int bitCount(long i)

Returns the number of one-bits in the two's complement binary representation of the specified long value. This function is sometimes referred to as the population count.

Returns:

the number of one-bits in the two's complement binary representation of the specified long value.

Since:

1.5

rotateLeft

public static long rotateLeft(long i, int distance)

Returns the value obtained by rotating the two's complement binary representation of the specified long value left by the specified number of bits. (Bits shifted out of the left hand, or high-order, side reenter on the right, or low-order.)

Note that left rotation with a negative distance is equivalent to right rotation: rotateLeft(val, -distance) == rotateRight(val, distance). Note also that rotation by any multiple of 64 is a no-op, so all but the last six bits of the rotation distance can be ignored, even if the distance is negative: rotateLeft(val, distance) == rotateLeft(val, distance & 0x3F).

Returns:

the value obtained by rotating the two's complement binary representation of the specified long value left by the specified number of bits.

Since:

1.5

rotateRight

public static long rotateRight(long i, int distance)

Returns the value obtained by rotating the two's complement binary representation of the specified long value right by the specified number of bits. (Bits shifted out of the right hand, or low-order, side reenter on the left, or high-order.)

Note that right rotation with a negative distance is equivalent to left rotation: rotateRight(val, -distance) == rotateLeft(val, distance). Note also that rotation by any multiple of 64 is a no-op, so all but the last six bits of the rotation distance can be ignored, even if the distance is negative: rotateRight(val, distance) == rotateRight(val, distance & 0x3F).

Returns:

the value obtained by rotating the two's complement binary representation of the specified long value right by the specified number of bits.

Since:

1.5

reverse

public static long reverse(long i)

Returns the value obtained by reversing the order of the bits in the two's complement binary representation of the specified long value.

Returns:

the value obtained by reversing order of the bits in the specified long value.

Since:

1.5

signum

public static int signum(long i)

Returns the signum function of the specified long value. (The return value is -1 if the specified value is negative; 0 if the specified value is zero; and 1 if the specified value is positive.)

Returns:

the signum function of the specified long value.

Since:

1.5

reverseBytes

public static long reverseBytes(long i)

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

Returns:

the value obtained by reversing the bytes in the specifiedlong 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.