Added in API level 24

OptionalInt

class OptionalInt

kotlin.Any
↳	java.util.OptionalInt

A container object which may or may not contain a int value. If a value is present, isPresent() will return true and getAsInt() will return the value.

Additional methods that depend on the presence or absence of a contained value are provided, such as orElse() (return a default value if value not present) and ifPresent() (execute a block of code if the value is present).

Summary

Public methods
static OptionalInt!	`empty()` Returns an empty `OptionalInt` instance.
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this OptionalInt.
Int	`getAsInt()` If a value is present in this `OptionalInt`, returns the value, otherwise throws `NoSuchElementException`.
Int	`hashCode()` Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.
Unit	`ifPresent(consumer: IntConsumer!)` Have the specified consumer accept the value if a value is present, otherwise do nothing.
Boolean	`isPresent()` Return `true` if there is a value present, otherwise `false`.
static OptionalInt!	`of(value: Int)` Return an `OptionalInt` with the specified value present.
Int	`orElse(other: Int)` Return the value if present, otherwise return `other`.
Int	`orElseGet(other: IntSupplier!)` Return the value if present, otherwise invoke `other` and return the result of that invocation.
Int	`orElseThrow(exceptionSupplier: Supplier<X>!)` Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.
String	`toString()` Returns a string representation of the object.

Public methods

empty

Added in API level 24

static fun empty(): OptionalInt!

Returns an empty OptionalInt instance. No value is present for this OptionalInt.

Return
`OptionalInt!`	an empty `OptionalInt`

equals

Added in API level 24

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this OptionalInt. The other object is considered equal if:

it is also an OptionalInt and;
both instances have no value present or;
the present values are "equal to" each other via ==.

Parameters
`obj`	an object to be tested for equality

Return
`Boolean`	{code true} if the other object is "equal to" this object otherwise `false`

getAsInt

Added in API level 24

fun getAsInt(): Int

If a value is present in this OptionalInt, returns the value, otherwise throws NoSuchElementException.

Return
`Int`	the value held by this `OptionalInt`

Exceptions
`java.util.NoSuchElementException`	if there is no value present

See Also

java.util.OptionalInt#isPresent()

hashCode

Added in API level 24

fun hashCode(): Int

Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.

Return
`Int`	hash code value of the present value or 0 if no value is present

ifPresent

Added in API level 24

fun ifPresent(consumer: IntConsumer!): Unit

Have the specified consumer accept the value if a value is present, otherwise do nothing.

Parameters
`consumer`	IntConsumer!: block to be executed if a value is present

Exceptions
`java.lang.NullPointerException`	if value is present and `consumer` is null

isPresent

Added in API level 24

fun isPresent(): Boolean

Return true if there is a value present, otherwise false.

Return
`Boolean`	`true` if there is a value present, otherwise `false`

of

Added in API level 24

static fun of(value: Int): OptionalInt!

Return an OptionalInt with the specified value present.

Parameters
`value`	Int: the value to be present

Return
`OptionalInt!`	an `OptionalInt` with the value present

orElse

Added in API level 24

fun orElse(other: Int): Int

Return the value if present, otherwise return other.

Parameters
`other`	Int: the value to be returned if there is no value present

Return
`Int`	the value, if present, otherwise `other`

orElseGet

Added in API level 24

fun orElseGet(other: IntSupplier!): Int

Return the value if present, otherwise invoke other and return the result of that invocation.

Parameters
`other`	IntSupplier!: a `IntSupplier` whose result is returned if no value is present

Return
`Int`	the value if present otherwise the result of `other.getAsInt()`

Exceptions
`java.lang.NullPointerException`	if value is not present and `other` is null

orElseThrow

Added in API level 24

fun <X : Throwable!> orElseThrow(exceptionSupplier: Supplier<X>!): Int

Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.

Parameters
`<X>`	Type of the exception to be thrown
`exceptionSupplier`	Supplier<X>!: The supplier which will return the exception to be thrown

Return
`Int`	the present value

Exceptions
`X`	if there is no value present
`java.lang.NullPointerException`	if no value is present and `exceptionSupplier` is null

toString

Added in API level 24

fun toString(): String

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns a non-empty string representation of this object suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.

Return
`String`	the string representation of this instance