com.annimon.stream

Class OptionalInt

java.lang.Object

com.annimon.stream.OptionalInt

public final class OptionalInt
extends java.lang.Object

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.

Method Summary

Methods

Modifier and Type	Method and Description
static OptionalInt	empty() Returns an empty OptionalInt instance.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this OptionalInt.
int	get() 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.
void	ifPresent(IntConsumer consumer) Invokes consumer function with value if present, otherwise does nothing.
void	ifPresentOrElse(IntConsumer consumer, java.lang.Runnable emptyAction) If a value is present, performs the given action with the value, otherwise performs the empty-based action.
boolean	isPresent() Return true if there is a value present, otherwise false.
static OptionalInt	of(int value) Return an OptionalInt with the specified value present.
int	or(int other) Returns the value if present, otherwise returns other.
int	orGet(IntSupplier other) Returns the value if present, otherwise invokes other and returns the result of that invocation.
<X extends java.lang.Throwable> int	orThrow(Supplier<X> exceptionSupplier) Returns the value if present, otherwise throws an exception provided by supplier function.
IntStream	stream() Wraps a value into IntStream if present, otherwise returns an empty IntStream.
java.lang.String	toString() Returns a non-empty string representation of this object suitable for debugging.

Methods inherited from class java.lang.Object

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

of

public static OptionalInt of(int value)

Return an OptionalInt with the specified value present.

Parameters:

value - the value to be present

Returns:

an OptionalInt with the value present

get

public int get()

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

Returns:

the value held by this OptionalInt

Throws:

java.util.NoSuchElementException - if there is no value present

See Also:

isPresent()

isPresent

public boolean isPresent()

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

Returns:

true if there is a value present, otherwise false

ifPresent

public void ifPresent(IntConsumer consumer)

Invokes consumer function with value if present, otherwise does nothing.

Parameters:

consumer - block to be executed if a value is present

Throws:

java.lang.NullPointerException - if value is present and consumer is null

ifPresentOrElse

public void ifPresentOrElse(IntConsumer consumer,
                   java.lang.Runnable emptyAction)

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

Parameters:

consumer - the consumer function to be executed, if a value is present

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

Throws:

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

Since:

1.1.4

stream

public IntStream stream()

Wraps a value into IntStream if present, otherwise returns an empty IntStream.

Returns:

the optional value as an IntStream

or

public int or(int other)

Returns the value if present, otherwise returns other.

Parameters:

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

Returns:

the value, if present, otherwise other

orGet

public int orGet(IntSupplier other)

Returns the value if present, otherwise invokes other and returns the result of that invocation.

Parameters:

other - a IntSupplier whose result is returned if no value is present

Returns:

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

Throws:

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

orThrow

public <X extends java.lang.Throwable> int orThrow(Supplier<X> exceptionSupplier)
            throws X extends java.lang.Throwable

Returns the value if present, otherwise throws an exception provided by supplier function.

Type Parameters:

X - the type of exception to be thrown

Parameters:

exceptionSupplier - supplier function that produces an exception to be thrown

Returns:

inner value if present

Throws:

X - if inner value is not present

X extends java.lang.Throwable

equals

public boolean equals(java.lang.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 java.lang.Object

Parameters:

obj - an object to be tested for equality

Returns:

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

hashCode

public int hashCode()

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

Overrides:

hashCode in class java.lang.Object

Returns:

hash code value of the present value or 0 if no value is present

toString

public java.lang.String toString()

Returns a non-empty string representation of this object suitable for debugging.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this instance