Documentation  › java.lang  › Long
 
 


  Long
  public final

  Inherits From:   Number : Object
  Conforms To:   Comparable
  Declared In:   java.lang


Class Description
 
The Long class wraps a value of the primitive type long 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 a long to a String and a String to a long, as well as other constants and methods useful when dealing with a long.



Class Variables
 
MIN_VALUE
public static final long

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


MAX_VALUE
public static final long

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


TYPE
public static final Class

The Class instance representing the primitive type long.


Instance Variables
 
None declared in this class.


Constructors
 
Long
public Long( long value )

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


Long
public Long( String s ) throws NumberFormatException

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


Class Methods
 
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 the String.


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 getProperty(java.lang.String) method. The string value of this property is then interpreted as a long value and a Long 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 a Long object equal to the value of:

getLong(nm, null)



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 getProperty(java.lang.String) method. The string value of this property is then interpreted as a long value and a Long 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. 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.


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 getProperty(java.lang.String) method. The string value of this property is then interpreted as a long value, as per the Long.decode method, and a Long 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 for the method 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 valueOf(java.lang.String,int) with radix 8.
  • Otherwise the property value is parsed as a decimal integer exactly as by the method valueOf(java.lang.String,int) 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.


parseLong
public static long parseLong( String s ) throws NumberFormatException

Parses the string argument as a signed decimal long. 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 radix 10 were given as arguments to the parseLong(java.lang.String,int) 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.


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 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 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 either L 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 MIN_RADIX or larger than 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 long.

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 



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


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 toUpperCase() method may be called on the result:
 
Long.toHexString(n).toUpperCase() 



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


toString
public static String toString( long i )

Returns a String object representing the specified long. 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) method.


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 radix 10 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 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 toUpperCase() method may be called on the result:
 
Long.toString(n, 16).toUpperCase() 



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 a Long 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)) 



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 signed long in the radix specified by the second argument, exactly as if the arguments were given to the parseLong(java.lang.String,int) method. The result is a Long 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))


Instance Methods
 
byteValue
public byte byteValue( )

Returns the value of this Long as a byte.


compareTo
public int compareTo( Long anotherLong )

Compares two Long objects numerically.


compareTo
public int compareTo( Object o )

Compares this Long object to another object. If the object is a Long, this function behaves like compareTo(Long). Otherwise, it throws a ClassCastException (as Long objects are comparable only to other Long objects).


doubleValue
public double doubleValue( )

Returns the value of this Long as a double.


equals
public boolean equals( Object obj )

Compares this object to the specified object. The result is true if and only if the argument is not null and is a Long object that contains the same long value as this object.


floatValue
public float floatValue( )

Returns the value of this Long as a float.


hashCode
public int hashCode( )

Returns a hash code for this Long. The result is the exclusive OR of the two halves of the primitive long value held by this Long object. That is, the hashcode is the value of the expression:
 
(int)(this.longValue()^(this.longValue()>>>32)) 



intValue
public int intValue( )

Returns the value of this Long as an int.


longValue
public long longValue( )

Returns the value of this Long as a long value.


shortValue
public short shortValue( )

Returns the value of this Long as a short.


toString
public String toString( )

Returns a String object representing this Long'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 the toString(long) method.


Known Subclasses
 
None.



 
 
  dydoc
  3/10/05