Long

BYTES

static val BYTES: Int

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

Value: 8

MAX_VALUE

static val MAX_VALUE: Long

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

Value: 9223372036854775807L

MIN_VALUE

static val MIN_VALUE: Long

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

Value: -9223372036854775808L

SIZE

static val SIZE: Int

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

Value: 64

Long

Long(value: Long)

Deprecated: It is rarely appropriate to use this constructor. The static factory valueOf(long) is generally a better choice, as it is likely to yield significantly better space and time performance.

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

Long

Long(s: String)

Deprecated: It is rarely appropriate to use this constructor. Use parseLong(java.lang.String) to convert a string to a long primitive, or use valueOf(java.lang.String) to convert a string to a Long object.

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.

bitCount

static fun bitCount(i: Long): Int

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.

compare

static fun compare(
    x: Long, 
    y: Long
): Int

Compares two long values numerically. The value returned is identical to what would be returned by:

Long.valueOf(x).compareTo(Long.valueOf(y))
  

compareTo

fun compareTo(other: Long): Int

Compares two Long objects numerically.

compareUnsigned

static fun compareUnsigned(
    x: Long, 
    y: Long
): Int

Compares two long values numerically treating the values as unsigned.

decode

static fun decode(nm: String): Long

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:

-

+

The sequence of characters following an optional 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.

divideUnsigned

static fun divideUnsigned(
    dividend: Long, 
    divisor: Long
): Long

Returns the unsigned quotient of dividing the first argument by the second where each argument and the result is interpreted as an unsigned value.

Note that in two's complement arithmetic, the three other basic arithmetic operations of add, subtract, and multiply are bit-wise identical if the two operands are regarded as both being signed or both being unsigned. Therefore separate addUnsigned, etc. methods are not provided.

equals

fun equals(other: Any?): Boolean

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.

getLong

static fun getLong(nm: String): Long?

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

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

static fun getLong(
    nm: String, 
    val: Long
): Long?

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

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:

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

getLong

static fun getLong(
    nm: String, 
    val: Long?
): Long?

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

• 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 ('\u005Cu004C') nor l ('\u005Cu006C') 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.

hashCode

fun hashCode(): Int

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

hashCode

static fun hashCode(value: Long): Int

Returns a hash code for a long value; compatible with Long.hashCode().

highestOneBit

static fun highestOneBit(i: Long): Long

Returns a long value with at most a single one-bit, in the position of the highest-order ("leftmost") one-bit in the specified long 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.

lowestOneBit

static fun lowestOneBit(i: Long): Long

Returns a long value with at most a single one-bit, in the position of the lowest-order ("rightmost") one-bit in the specified long 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.

max

static fun max(
    a: Long, 
    b: Long
): Long

Returns the greater of two long values as if by calling Math.max.

min

static fun min(
    a: Long, 
    b: Long
): Long

Returns the smaller of two long values as if by calling Math.min.

numberOfLeadingZeros

static fun numberOfLeadingZeros(i: Long): Int

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)

numberOfTrailingZeros

static fun numberOfTrailingZeros(i: Long): Int

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

parseLong

static fun parseLong(
    s: String, 
    radix: Int
): Long

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 java.lang.Character#digit(char, int) returns a nonnegative value), except that the first character may be an ASCII minus sign '-' ('\u005Cu002D') to indicate a negative value or an ASCII plus sign '+' ('\u005Cu002B') to indicate a positive value. The resulting long value is returned.

Note that neither the character L ('\u005Cu004C') nor l ('\u005Cu006C') 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 or equal to 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 java.lang.Character#MIN_RADIX or larger than 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 '-' ('\u005Cu002d') or plus sign '+' ('\u005Cu002B') 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("+42", 10) returns 42L
  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
  

parseLong

static fun parseLong(
    s: CharSequence, 
    beginIndex: Int, 
    endIndex: Int, 
    radix: Int
): Long

Parses the CharSequence argument as a signed long in the specified radix, beginning at the specified beginIndex and extending to endIndex - 1.

The method does not take steps to guard against the CharSequence being mutated while parsing.

parseLong

static fun parseLong(s: String): Long

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 '-' (\u005Cu002D') to indicate a negative value or an ASCII plus sign '+' ('\u005Cu002B') to indicate a positive 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 ('\u005Cu004C') nor l ('\u005Cu006C') is permitted to appear at the end of the string as a type indicator, as would be permitted in Java programming language source code.

parseUnsignedLong

static fun parseUnsignedLong(
    s: String, 
    radix: Int
): Long

Parses the string argument as an unsigned long in the radix specified by the second argument. An unsigned integer maps the values usually associated with negative numbers to positive numbers larger than MAX_VALUE. The characters in the string must all be digits of the specified radix (as determined by whether java.lang.Character#digit(char, int) returns a nonnegative value), except that the first character may be an ASCII plus sign '+' ('\u005Cu002B'). 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 java.lang.Character#MIN_RADIX or larger than 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 plus sign '+' ('\u005Cu002B') provided that the string is longer than length 1.
• The value represented by the string is larger than the largest unsigned long, 264-1.

parseUnsignedLong

static fun parseUnsignedLong(
    s: CharSequence, 
    beginIndex: Int, 
    endIndex: Int, 
    radix: Int
): Long

Parses the CharSequence argument as an unsigned long in the specified radix, beginning at the specified beginIndex and extending to endIndex - 1.

The method does not take steps to guard against the CharSequence being mutated while parsing.

parseUnsignedLong

static fun parseUnsignedLong(s: String): Long

Parses the string argument as an unsigned decimal long. The characters in the string must all be decimal digits, except that the first character may be an ASCII plus sign '+' ('\u005Cu002B'). The resulting integer value is returned, exactly as if the argument and the radix 10 were given as arguments to the parseUnsignedLong(java.lang.String,int) method.

remainderUnsigned

static fun remainderUnsigned(
    dividend: Long, 
    divisor: Long
): Long

Returns the unsigned remainder from dividing the first argument by the second where each argument and the result is interpreted as an unsigned value.

reverse

static fun reverse(i: Long): Long

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

reverseBytes

static fun reverseBytes(i: Long): Long

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

rotateLeft

static fun rotateLeft(
    i: Long, 
    distance: Int
): Long

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

rotateRight

static fun rotateRight(
    i: Long, 
    distance: Int
): Long

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

signum

static fun signum(i: Long): Int

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

sum

static fun sum(
    a: Long, 
    b: Long
): Long

Adds two long values together as per the + operator.

toBinaryString

static fun toBinaryString(i: Long): String

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.

The value of the argument can be recovered from the returned string s by calling 2).

If the unsigned magnitude is zero, it is represented by a single zero character '0' ('\u005Cu0030'); otherwise, the first character of the representation of the unsigned magnitude will not be the zero character. The characters '0' ('\u005Cu0030') and '1' ('\u005Cu0031') are used as binary digits.

toByte

fun toByte(): Byte

Returns the value of this Long as a byte after a narrowing primitive conversion.

toDouble

fun toDouble(): Double

Returns the value of this Long as a double after a widening primitive conversion.

toFloat

fun toFloat(): Float

Returns the value of this Long as a float after a widening primitive conversion.

toHexString

static fun toHexString(i: Long): String

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.

The value of the argument can be recovered from the returned string s by calling 16).

If the unsigned magnitude is zero, it is represented by a single zero character '0' ('\u005Cu0030'); 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:

toInt

fun toInt(): Int

Returns the value of this Long as an int after a narrowing primitive conversion.

toLong

fun toLong(): Long

Returns the value of this Long as a long value.

toOctalString

static fun toOctalString(i: Long): String

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.

The value of the argument can be recovered from the returned string s by calling 8).

If the unsigned magnitude is zero, it is represented by a single zero character '0' ('\u005Cu0030'); 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:

toShort

fun toShort(): Short

Returns the value of this Long as a short after a narrowing primitive conversion.

toString

fun toString(): String

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 java.lang.Long#toString(long) method.

toString

static fun toString(
    i: Long, 
    radix: Int
): String

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 '-' ('\u005Cu002d'). 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' ('\u005Cu0030'); otherwise, the first character of the representation of the magnitude will not be the zero character. The following ASCII characters are used as digits:

toString

static fun toString(i: Long): String

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.

toUnsignedString

static fun toUnsignedString(
    i: Long, 
    radix: Int
): String

Returns a string representation of the first argument as an unsigned integer value 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.

Note that since the first argument is treated as an unsigned value, no leading sign character is printed.

If the magnitude is zero, it is represented by a single zero character '0' ('\u005Cu0030'); otherwise, the first character of the representation of the magnitude will not be the zero character.

The behavior of radixes and the characters used as digits are the same as toString.

toUnsignedString

static fun toUnsignedString(i: Long): String

Returns a string representation of the argument as an unsigned decimal value. The argument is converted to unsigned decimal representation and returned as a string exactly as if the argument and radix 10 were given as arguments to the toUnsignedString(long,int) method.

valueOf

static fun valueOf(
    s: String, 
    radix: Int
): Long

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:

valueOf

static fun valueOf(s: String): Long

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:

valueOf

static fun valueOf(l: Long): Long

Returns a Long instance representing the specified long value. If a new Long instance is not required, this method should generally be used in preference to the constructor Long(long), as this method is likely to yield significantly better space and time performance by caching frequently requested values. This method will always cache values in the range -128 to 127, inclusive, and may cache other values outside of this range.

TYPE

static val TYPE: Class<Long!>!

The Class instance representing the primitive type long.