OptionalInt (FlexDoc/Javadoc 2.0 Demo)

A container object which may or may not contain an int value. If a value is present, isPresent() returns true. If no value is present, the object is considered empty and isPresent() returns false.

Additional methods that depend on the presence or absence of a contained value are provided, such as orElse() (returns a default value if no value is present) and ifPresent() (performs an action if a value is present).

This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail.

Since:

1.8

Method Summary
static OptionalInt	empty() Returns an empty OptionalInt instance.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this OptionalInt.
int	getAsInt() If a value is present, returns the value, otherwise throws NoSuchElementException.
int	hashCode() Returns the hash code of the value, if present, otherwise 0 (zero) if no value is present.
void	ifPresent(IntConsumer action) If a value is present, performs the given action with the value, otherwise does nothing.
void	ifPresentOrElse(IntConsumer action, Runnable emptyAction) If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
boolean	isEmpty() If a value is not present, returns true, otherwise false.
boolean	isPresent() If a value is present, returns true, otherwise false.
static OptionalInt	of(int value) Returns an OptionalInt describing the given value.
int	orElse(int other) If a value is present, returns the value, otherwise returns other.
int	orElseGet(IntSupplier supplier) If a value is present, returns the value, otherwise returns the result produced by the supplying function.
int	orElseThrow() If a value is present, returns the value, otherwise throws NoSuchElementException.
<X extends Throwable> int	orElseThrow(Supplier<? extends X> exceptionSupplier) If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
IntStream	stream() If a value is present, returns a sequential IntStream containing only that value, otherwise returns an empty IntStream.
String	toString() Returns a non-empty string representation of this OptionalInt suitable for debugging.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

empty

public static OptionalInt empty

()

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

Returns:

an empty OptionalInt

public static OptionalInt of

(int value)

Returns an OptionalInt describing the given value.

Parameters:

value - the value to describe

Returns:

an OptionalInt with the value present

getAsInt

public int getAsInt

()

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

Returns:

the value described by this OptionalInt

Throws:

NoSuchElementException - if no value is present

isPresent

public boolean isPresent

()

If a value is present, returns true, otherwise false.

Returns:

true if a value is present, otherwise false

isEmpty

public boolean isEmpty

()

If a value is not present, returns true, otherwise false.

Returns:

true if a value is not present, otherwise false

Since:

ifPresent

public void ifPresent

(IntConsumer action)

If a value is present, performs the given action with the value, otherwise does nothing.

Parameters:

action - the action to be performed, if a value is present

Throws:

NullPointerException - if value is present and the given action is null

ifPresentOrElse

public void ifPresentOrElse

(IntConsumer action,
Runnable emptyAction)

If a value is present, performs the given action with the value, otherwise performs the given empty-based action.

Parameters:

action - the action to be performed, if a value is present

emptyAction - the empty-based action to be performed, if no value is present

Throws:

NullPointerException - if a value is present and the given action is null, or no value is present and the given empty-based action is null.

Since:

stream

public IntStream stream

()

If a value is present, returns a sequential IntStream containing only that value, otherwise returns an empty IntStream.

Returns:

the optional value as an IntStream

Since:

orElse

public int orElse

(int other)

If a value is present, returns the value, otherwise returns other.

Parameters:

other - the value to be returned, if no value is present

Returns:

the value, if present, otherwise other

orElseGet

public int orElseGet

(IntSupplier supplier)

If a value is present, returns the value, otherwise returns the result produced by the supplying function.

Parameters:

supplier - the supplying function that produces a value to be returned

Returns:

the value, if present, otherwise the result produced by the supplying function

Throws:

NullPointerException - if no value is present and the supplying function is null

orElseThrow

public int orElseThrow

()

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

Returns:

the value described by this OptionalInt

Throws:

NoSuchElementException - if no value is present

Since:

orElseThrow

public <X extends Throwable> int orElseThrow	(Supplier<? extends X> exceptionSupplier)
throws	X

If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionSupplier - the supplying function that produces an exception to be thrown

Returns:

the value, if present

Throws:

X - if no value is present

NullPointerException - if no value is present and the exception supplying function is null

Throwable

equals

public boolean equals

(Object obj)

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

Overrides:

equals in class Object

Parameters:

obj - an object to be tested for equality

Returns:

true if the other object is "equal to" this object otherwise false