Added in API level 1

Integer

class Integer : Number, Comparable<Int!>

kotlin.Any
↳	kotlin.Number
	↳	java.lang.Integer

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.

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

Summary

Constants
static Int	BYTES The number of bytes used to represent an int value in two's complement binary form.
static Int	MAX_VALUE A constant holding the maximum value an int can have, 231-1.
static Int	MIN_VALUE A constant holding the minimum value an int can have, -231.
static Int	SIZE The number of bits used to represent an int value in two's complement binary form.

Public constructors
Integer(value: Int) Constructs a newly allocated Integer object that represents the specified int value.
Integer(s: String) Constructs a newly allocated Integer object that represents the int value indicated by the String parameter.

Public methods
static Int	bitCount(i: Int) Returns the number of one-bits in the two's complement binary representation of the specified int value.
static Int	compare(x: Int, y: Int) Compares two int values numerically.
Int	compareTo(other: Int) Compares two Integer objects numerically.
static Int	compareUnsigned(x: Int, y: Int) Compares two int values numerically treating the values as unsigned.
static Int	decode(nm: String) Decodes a String into an Integer.
static Int	divideUnsigned(dividend: Int, divisor: Int) Returns the unsigned quotient of dividing the first argument by the second where each argument and the result is interpreted as an unsigned value.
Boolean	equals(other: Any?) Compares this object to the specified object.
static Int?	getInteger(nm: String) Determines the integer value of the system property with the specified name.
static Int?	getInteger(nm: String, val: Int) Determines the integer value of the system property with the specified name.
static Int?	getInteger(nm: String, val: Int?) Returns the integer value of the system property with the specified name.
Int	hashCode() Returns a hash code for this Integer.
static Int	hashCode(value: Int) Returns a hash code for an int value; compatible with Integer.hashCode().
static Int	highestOneBit(i: Int) Returns an int value with at most a single one-bit, in the position of the highest-order ("leftmost") one-bit in the specified int value.
static Int	lowestOneBit(i: Int) Returns an int value with at most a single one-bit, in the position of the lowest-order ("rightmost") one-bit in the specified int value.
static Int	max(a: Int, b: Int) Returns the greater of two int values as if by calling Math.max.
static Int	min(a: Int, b: Int) Returns the smaller of two int values as if by calling Math.min.
static Int	numberOfLeadingZeros(i: Int) Returns the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified int value.
static Int	numberOfTrailingZeros(i: Int) Returns the number of zero bits following the lowest-order ("rightmost") one-bit in the two's complement binary representation of the specified int value.
static Int	parseInt(s: CharSequence, beginIndex: Int, endIndex: Int, radix: Int) Parses the CharSequence argument as a signed int in the specified radix, beginning at the specified beginIndex and extending to endIndex - 1.
static Int	parseInt(s: String) Parses the string argument as a signed decimal integer.
static Int	parseInt(s: String, radix: Int) Parses the string argument as a signed integer in the radix specified by the second argument.
static Int	parseUnsignedInt(s: CharSequence, beginIndex: Int, endIndex: Int, radix: Int) Parses the CharSequence argument as an unsigned int in the specified radix, beginning at the specified beginIndex and extending to endIndex - 1.
static Int	parseUnsignedInt(s: String) Parses the string argument as an unsigned decimal integer.
static Int	parseUnsignedInt(s: String, radix: Int) Parses the string argument as an unsigned integer in the radix specified by the second argument.
static Int	remainderUnsigned(dividend: Int, divisor: Int) Returns the unsigned remainder from dividing the first argument by the second where each argument and the result is interpreted as an unsigned value.
static Int	reverse(i: Int) Returns the value obtained by reversing the order of the bits in the two's complement binary representation of the specified int value.
static Int	reverseBytes(i: Int) Returns the value obtained by reversing the order of the bytes in the two's complement representation of the specified int value.
static Int	rotateLeft(i: Int, distance: Int) Returns the value obtained by rotating the two's complement binary representation of the specified int value left by the specified number of bits.
static Int	rotateRight(i: Int, distance: Int) Returns the value obtained by rotating the two's complement binary representation of the specified int value right by the specified number of bits.
static Int	signum(i: Int) Returns the signum function of the specified int value.
static Int	sum(a: Int, b: Int) Adds two integers together as per the + operator.
static String	toBinaryString(i: Int) Returns a string representation of the integer argument as an unsigned integer in base 2.
Byte	toByte() Returns the value of this Integer as a byte after a narrowing primitive conversion.
Double	toDouble() Returns the value of this Integer as a double after a widening primitive conversion.
Float	toFloat() Returns the value of this Integer as a float after a widening primitive conversion.
static String	toHexString(i: Int) Returns a string representation of the integer argument as an unsigned integer in base 16.
Int	toInt() Returns the value of this Integer as an int.
Long	toLong() Returns the value of this Integer as a long after a widening primitive conversion.
static String	toOctalString(i: Int) Returns a string representation of the integer argument as an unsigned integer in base 8.
Short	toShort() Returns the value of this Integer as a short after a narrowing primitive conversion.
String	toString() Returns a String object representing this Integer's value.
static String	toString(i: Int) Returns a String object representing the specified integer.
static String	toString(i: Int, radix: Int) Returns a string representation of the first argument in the radix specified by the second argument.
static Long	toUnsignedLong(x: Int) Converts the argument to a long by an unsigned conversion.
static String	toUnsignedString(i: Int) Returns a string representation of the argument as an unsigned decimal value.
static String	toUnsignedString(i: Int, radix: Int) Returns a string representation of the first argument as an unsigned integer value in the radix specified by the second argument.
static Int	valueOf(i: Int) Returns an Integer instance representing the specified int value.
static Int	valueOf(s: String) Returns an Integer object holding the value of the specified String.
static Int	valueOf(s: String, radix: Int) Returns an Integer object holding the value extracted from the specified String when parsed with the radix given by the second argument.

Properties
static Class<Int!>!	TYPE The Class instance representing the primitive type int.

Constants

BYTES

Added in API level 24

static val BYTES: Int

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

Value: 4

MAX_VALUE

Added in API level 1

static val MAX_VALUE: Int

A constant holding the maximum value an int can have, 231-1.

Value: 2147483647

MIN_VALUE

Added in API level 1

static val MIN_VALUE: Int

A constant holding the minimum value an int can have, -231.

Value: -2147483648

SIZE

Added in API level 1

static val SIZE: Int

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

Value: 32

Public constructors

Integer

Added in API level 1

Integer(value: Int)

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

Constructs a newly allocated Integer object that represents the specified int value.

Parameters
value	Int: the value to be represented by the Integer object.

Integer

Added in API level 1

Integer(s: String)

Deprecated: It is rarely appropriate to use this constructor. Use parseInt(java.lang.String) to convert a string to a int primitive, or use valueOf(java.lang.String) to convert a string to an Integer object.

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.

Parameters
s	String: the String to be converted to an Integer.

Exceptions
java.lang.NumberFormatException	if the String does not contain a parsable integer.

Public methods

bitCount

Added in API level 1

static fun bitCount(i: Int): Int

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

Parameters
i	Int: the value whose bits are to be counted

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

compare

Added in API level 19

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

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

Integer.valueOf(x).compareTo(Integer.valueOf(y))
  

Parameters
x	Int: the first int to compare
y	Int: the second int to compare

Return
Int	the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

compareTo

Added in API level 1

fun compareTo(other: Int): Int

Compares two Integer objects numerically.

Parameters
o	the object to be compared.
anotherInteger	the Integer to be compared.

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

Exceptions
java.lang.NullPointerException	if the specified object is null
java.lang.ClassCastException	if the specified object's type prevents it from being compared to this object.

compareUnsigned

Added in API level 26

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

Compares two int values numerically treating the values as unsigned.

Parameters
x	Int: the first int to compare
y	Int: the second int to compare

Return
Int	the value 0 if x == y; a value less than 0 if x < y as unsigned values; and a value greater than 0 if x > y as unsigned values

decode

Added in API level 1

static fun decode(nm: String): Int

Decodes a String into an Integer. 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 as defined in section {@jls 3.10.1} of The Java Language Specification, except that underscores are not accepted between digits.

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

Parameters
nm	String: the String to decode.

Return
Int	an Integer object holding the int value represented by nm

Exceptions
java.lang.NumberFormatException	if the String does not contain a parsable integer.

See Also

• java.lang.Integer#parseInt(java.lang.String, int)

divideUnsigned

Added in API level 26

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

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.

Parameters
dividend	Int: the value to be divided
divisor	Int: the value doing the dividing

Return
Int	the unsigned quotient of the first argument divided by the second argument

See Also

• #remainderUnsigned

equals

Added in API level 1

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 an Integer object that contains the same int value as this object.

Parameters
obj	the object to compare with.

Return
Boolean	true if the objects are the same; false otherwise.

getInteger

Added in API level 1

static fun getInteger(nm: String): Int?

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 java.lang.System#getProperty(java.lang.String) method. The string value of this property is then interpreted as an integer value using the grammar supported by decode and an Integer 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 an Integer object equal to the value of:

getInteger(nm, null)

Parameters
nm	String: property name.

Return
Int?	the Integer value of the property.

Exceptions
java.lang.SecurityException	for the same reasons as System.getProperty

See Also

• java.lang.System#getProperty(java.lang.String)
• java.lang.System#getProperty(java.lang.String, java.lang.String)

getInteger

Added in API level 1

static fun getInteger(
    nm: String, 
    val: Int
): Int?

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

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.

Parameters
nm	String: property name.
val	Int?: default value.

Return
Int?	the Integer value of the property.

Exceptions
java.lang.SecurityException	for the same reasons as System.getProperty

See Also

• java.lang.System#getProperty(java.lang.String)
• java.lang.System#getProperty(java.lang.String, java.lang.String)

getInteger

Added in API level 1

static fun getInteger(
    nm: String, 
    val: Int?
): Int?

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 java.lang.System#getProperty(java.lang.String) method. The string value of this property is then interpreted as an integer value, as per the decode method, and an Integer 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 by 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.

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	String: property name.
val	Int?: default value.

Return
Int?	the Integer value of the property.

Exceptions
java.lang.SecurityException	for the same reasons as System.getProperty

See Also

• java.lang.System#getProperty(java.lang.String)
• java.lang.System#getProperty(java.lang.String, java.lang.String)

hashCode

Added in API level 1

fun hashCode(): Int

Returns a hash code for this Integer.

Return
Int	a hash code value for this object, equal to the primitive int value represented by this Integer object.

hashCode

Added in API level 24

static fun hashCode(value: Int): Int

Returns a hash code for an int value; compatible with Integer.hashCode().

Parameters
value	Int: the value to hash

Return
Int	a hash code value for an int value.

highestOneBit

Added in API level 1

static fun highestOneBit(i: Int): Int

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

Parameters
i	Int: the value whose highest one bit is to be computed

Return
Int	an int 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.

lowestOneBit

Added in API level 1

static fun lowestOneBit(i: Int): Int

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

Parameters
i	Int: the value whose lowest one bit is to be computed

Return
Int	an int 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.

max

Added in API level 24

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

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

Parameters
a	Int: the first operand
b	Int: the second operand

Return
Int	the greater of a and b

See Also

• java.util.function.BinaryOperator

min

Added in API level 24

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

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

Parameters
a	Int: the first operand
b	Int: the second operand

Return
Int	the smaller of a and b

See Also

• java.util.function.BinaryOperator

numberOfLeadingZeros

Added in API level 1

static fun numberOfLeadingZeros(i: Int): Int

Returns the number of zero bits preceding the highest-order ("leftmost") one-bit in the two's complement binary representation of the specified int value. Returns 32 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 int values x:

• floor(log2(x)) = 31 - numberOfLeadingZeros(x)
• ceil(log2(x)) = 32 - numberOfLeadingZeros(x - 1)

Parameters
i	Int: the value whose number of leading zeros is to be computed

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

numberOfTrailingZeros

Added in API level 1

static fun numberOfTrailingZeros(i: Int): Int

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

Parameters
i	Int: the value whose number of trailing zeros is to be computed

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

parseInt

Added in API level 33

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

Parses the CharSequence argument as a signed int 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.

Parameters
s	CharSequence: the CharSequence containing the int representation to be parsed
beginIndex	Int: the beginning index, inclusive.
endIndex	Int: the ending index, exclusive.
radix	Int: the radix to be used while parsing s.

Return
Int	the signed int represented by the subsequence in the specified radix.

Exceptions
java.lang.NullPointerException	if s is null.
java.lang.IndexOutOfBoundsException	if beginIndex is negative, or if beginIndex is greater than endIndex or if endIndex is greater than s.length().
java.lang.NumberFormatException	if the CharSequence does not contain a parsable int in the specified radix, or if radix is either smaller than java.lang.Character#MIN_RADIX or larger than java.lang.Character#MAX_RADIX.

parseInt

Added in API level 1

static fun parseInt(s: String): Int

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 '-' ('\u005Cu002D') to indicate a negative value or an ASCII plus sign '+' ('\u005Cu002B') to indicate a positive value. The resulting integer value is returned, exactly as if the argument and the radix 10 were given as arguments to the parseInt(java.lang.String,int) method.

Parameters
s	String: a String containing the int representation to be parsed

Return
Int	the integer value represented by the argument in decimal.

Exceptions
java.lang.NumberFormatException	if the string does not contain a parsable integer.

parseInt

Added in API level 1

static fun parseInt(
    s: String, 
    radix: Int
): Int

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

Examples:

parseInt("0", 10) returns 0
  parseInt("473", 10) returns 473
  parseInt("+42", 10) returns 42
  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
  

Parameters
s	String: the String containing the integer representation to be parsed
radix	Int: the radix to be used while parsing s.

Return
Int	the integer represented by the string argument in the specified radix.

Exceptions
java.lang.NumberFormatException	if the String does not contain a parsable int.

parseUnsignedInt

Added in API level 33

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

Parses the CharSequence argument as an unsigned int 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.

Parameters
s	CharSequence: the CharSequence containing the unsigned int representation to be parsed
beginIndex	Int: the beginning index, inclusive.
endIndex	Int: the ending index, exclusive.
radix	Int: the radix to be used while parsing s.

Return
Int	the unsigned int represented by the subsequence in the specified radix.

Exceptions
java.lang.NullPointerException	if s is null.
java.lang.IndexOutOfBoundsException	if beginIndex is negative, or if beginIndex is greater than endIndex or if endIndex is greater than s.length().
java.lang.NumberFormatException	if the CharSequence does not contain a parsable unsigned int in the specified radix, or if radix is either smaller than java.lang.Character#MIN_RADIX or larger than java.lang.Character#MAX_RADIX.

parseUnsignedInt

Added in API level 26

static fun parseUnsignedInt(s: String): Int

Parses the string argument as an unsigned decimal integer. 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 parseUnsignedInt(java.lang.String,int) method.

Parameters
s	String: a String containing the unsigned int representation to be parsed

Return
Int	the unsigned integer value represented by the argument in decimal.

Exceptions
java.lang.NumberFormatException	if the string does not contain a parsable unsigned integer.

parseUnsignedInt

Added in API level 26

static fun parseUnsignedInt(
    s: String, 
    radix: Int
): Int

Parses the string argument as an unsigned integer 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 int, 232-1.

Parameters
s	String: the String containing the unsigned integer representation to be parsed
radix	Int: the radix to be used while parsing s.

Return
Int	the integer represented by the string argument in the specified radix.

Exceptions
java.lang.NumberFormatException	if the String does not contain a parsable int.

remainderUnsigned

Added in API level 26

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

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

Parameters
dividend	Int: the value to be divided
divisor	Int: the value doing the dividing

Return
Int	the unsigned remainder of the first argument divided by the second argument

See Also

• #divideUnsigned

reverse

Added in API level 1

static fun reverse(i: Int): Int

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

Parameters
i	Int: the value to be reversed

Return
Int	the value obtained by reversing order of the bits in the specified int value.

reverseBytes

Added in API level 1

static fun reverseBytes(i: Int): Int

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

Parameters
i	Int: the value whose bytes are to be reversed

Return
Int	the value obtained by reversing the bytes in the specified int value.

rotateLeft

Added in API level 1

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

Returns the value obtained by rotating the two's complement binary representation of the specified int 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 32 is a no-op, so all but the last five bits of the rotation distance can be ignored, even if the distance is negative: rotateLeft(val, distance) == rotateLeft(val, distance & 0x1F).

Parameters
i	Int: the value whose bits are to be rotated left
distance	Int: the number of bit positions to rotate left

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

rotateRight

Added in API level 1

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

Returns the value obtained by rotating the two's complement binary representation of the specified int 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 32 is a no-op, so all but the last five bits of the rotation distance can be ignored, even if the distance is negative: rotateRight(val, distance) == rotateRight(val, distance & 0x1F).

Parameters
i	Int: the value whose bits are to be rotated right
distance	Int: the number of bit positions to rotate right

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

signum

Added in API level 1

static fun signum(i: Int): Int

Returns the signum function of the specified int 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.)

Parameters
i	Int: the value whose signum is to be computed

Return
Int	the signum function of the specified int value.

sum

Added in API level 24

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

Adds two integers together as per the + operator.

Parameters
a	Int: the first operand
b	Int: the second operand

Return
Int	the sum of a and b

See Also

• java.util.function.BinaryOperator

toBinaryString

Added in API level 1

static fun toBinaryString(i: Int): String

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.

The value of the argument can be recovered from the returned string s by calling Integer.parseUnsignedInt(s, 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.

Parameters
i	Int: an integer to be converted to a string.

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

See Also

• #parseUnsignedInt(String, int)
• #toUnsignedString(int, int)

toByte

Added in API level 1

fun toByte(): Byte

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

Return
Byte	the numeric value represented by this object after conversion to type byte.

toDouble

Added in API level 1

fun toDouble(): Double

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

Return
Double	the numeric value represented by this object after conversion to type double.

toFloat

Added in API level 1

fun toFloat(): Float

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

Return
Float	the numeric value represented by this object after conversion to type float.

toHexString

Added in API level 1

static fun toHexString(i: Int): String

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.

The value of the argument can be recovered from the returned string s by calling Integer.parseUnsignedInt(s, 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:

0123456789abcdef These are the characters '\u005Cu0030' through '\u005Cu0039' and '\u005Cu0061' through '\u005Cu0066'. If uppercase letters are desired, the java.lang.String#toUpperCase() method may be called on the result: Integer.toHexString(n).toUpperCase()

Parameters
i	Int: an integer to be converted to a string.

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

See Also

• #parseUnsignedInt(String, int)
• #toUnsignedString(int, int)

toInt

Added in API level 1

fun toInt(): Int

Returns the value of this Integer as an int.

Return
Int	the numeric value represented by this object after conversion to type int.

toLong

Added in API level 1

fun toLong(): Long

Returns the value of this Integer as a long after a widening primitive conversion.

Return
Long	the numeric value represented by this object after conversion to type long.

See Also

• java.lang.Integer#toUnsignedLong(int)

toOctalString

Added in API level 1

static fun toOctalString(i: Int): String

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.

The value of the argument can be recovered from the returned string s by calling Integer.parseUnsignedInt(s, 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:

01234567 These are the characters '\u005Cu0030' through '\u005Cu0037'.

Parameters
i	Int: an integer to be converted to a string.

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

See Also

• #parseUnsignedInt(String, int)
• #toUnsignedString(int, int)

toShort

Added in API level 1

fun toShort(): Short

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

Return
Short	the numeric value represented by this object after conversion to type short.

toString

Added in API level 1

fun toString(): String

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

Return
String	a string representation of the value of this object in base 10.

toString

Added in API level 1

static fun toString(i: Int): String

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 toString(int,int) method.

Parameters
i	Int: an integer to be converted.

Return
String	a string representation of the argument in base 10.

toString

Added in API level 1

static fun toString(
    i: Int, 
    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 character '-' ('\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:

0123456789abcdefghijklmnopqrstuvwxyz These are '\u005Cu0030' through '\u005Cu0039' and '\u005Cu0061' through '\u005Cu007A'. 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 java.lang.String#toUpperCase() method may be called on the result: Integer.toString(n, 16).toUpperCase()

Parameters
i	Int: an integer to be converted to a string.
radix	Int: the radix to use in the string representation.

Return
String	a string representation of the argument in the specified radix.

See Also

• java.lang.Character#MAX_RADIX
• java.lang.Character#MIN_RADIX

toUnsignedLong

Added in API level 26

static fun toUnsignedLong(x: Int): Long

Converts the argument to a long by an unsigned conversion. In an unsigned conversion to a long, the high-order 32 bits of the long are zero and the low-order 32 bits are equal to the bits of the integer argument. Consequently, zero and positive int values are mapped to a numerically equal long value and negative int values are mapped to a long value equal to the input plus 232.

Parameters
x	Int: the value to convert to an unsigned long

Return
Long	the argument converted to long by an unsigned conversion

toUnsignedString

Added in API level 26

static fun toUnsignedString(i: Int): 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(int,int) method.

Parameters
i	Int: an integer to be converted to an unsigned string.

Return
String	an unsigned string representation of the argument.

See Also

• #toUnsignedString(int, int)

toUnsignedString

Added in API level 26

static fun toUnsignedString(
    i: Int, 
    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.

Parameters
i	Int: an integer to be converted to an unsigned string.
radix	Int: the radix to use in the string representation.

Return
String	an unsigned string representation of the argument in the specified radix.

See Also

• #toString(int, int)

valueOf

Added in API level 1

static fun valueOf(i: Int): Int

Returns an Integer instance representing the specified int value. If a new Integer instance is not required, this method should generally be used in preference to the constructor Integer(int), 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.

Parameters
i	Int: an int value.

Return
Int	an Integer instance representing i.

valueOf

Added in API level 1

static fun valueOf(s: String): Int

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

Parameters
s	String: the string to be parsed.

Return
Int	an Integer object holding the value represented by the string argument.

Exceptions
java.lang.NumberFormatException	if the string cannot be parsed as an integer.

valueOf

Added in API level 1

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

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

Parameters
s	String: the string to be parsed.
radix	Int: the radix to be used in interpreting s

Return
Int	an Integer object holding the value represented by the string argument in the specified radix.

Exceptions
java.lang.NumberFormatException	if the String does not contain a parsable int.

Properties

TYPE

Added in API level 1

static val TYPE: Class<Int!>!

The Class instance representing the primitive type int.