OptionalInt (stream 1.2.2 API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`custom(Function<OptionalInt,R> function)` Applies custom operator on `OptionalInt`.
`static OptionalInt`	`empty()` Returns an empty `OptionalInt` instance.
`boolean`	`equals(java.lang.Object obj)` Indicates whether some other object is "equal to" this OptionalInt.
`OptionalInt`	`executeIfAbsent(java.lang.Runnable action)` Invokes action function if value is absent.
`OptionalInt`	`executeIfPresent(IntConsumer consumer)` Invokes consumer function with value if present.
`OptionalInt`	`filter(IntPredicate predicate)` Performs filtering on inner value if it is present.
`OptionalInt`	`filterNot(IntPredicate predicate)` Performs negated filtering on inner value if it is present.
`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.
`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`	`isEmpty()` Checks the value is not present.
`boolean`	`isPresent()` Return `true` if there is a value present, otherwise `false`.
`OptionalInt`	`map(IntUnaryOperator mapper)` Invokes mapping function on inner value if present.
`OptionalDouble`	`mapToDouble(IntToDoubleFunction mapper)` Invokes mapping function on inner value if present.
`OptionalLong`	`mapToLong(IntToLongFunction mapper)` Invokes mapping function on inner value if present.
`<U> Optional<U>`	`mapToObj(IntFunction<U> mapper)` Invokes mapping function on inner value if present.
`static OptionalInt`	`of(int value)` Return an `OptionalInt` with the specified value present.
`static OptionalInt`	`ofNullable(java.lang.Integer value)` Returns an `OptionalInt` with the specified value, or empty `OptionalInt` if value is null.
`OptionalInt`	`or(Supplier<OptionalInt> supplier)` Returns current `OptionalInt` if value is present, otherwise returns an `OptionalInt` produced by supplier function.
`int`	`orElse(int other)` Returns the value if present, otherwise returns `other`.
`int`	`orElseGet(IntSupplier other)` Returns the value if present, otherwise invokes `other` and returns the result of that invocation.
`int`	`orElseThrow()` Returns inner value if present, otherwise throws `NoSuchElementException`.
`<X extends java.lang.Throwable> int`	`orElseThrow(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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - empty
```
@NotNull
public static OptionalInt empty()
```
    Returns an empty OptionalInt instance. No value is present for this OptionalInt.
    
    Returns:
    
    an empty OptionalInt
  - of
```
@NotNull
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
  - ofNullable
```
@NotNull
public static OptionalInt ofNullable(@Nullable
                                              java.lang.Integer value)
```
    Returns an OptionalInt with the specified value, or empty OptionalInt if value is null.
    
    Parameters:
    
    value - the value which can be null
    
    Returns:
    
    an OptionalInt
    
    Since:
    
    1.2.1
  - getAsInt
```
public int getAsInt()
```
    If a value is present in this OptionalInt, returns the value, otherwise throws NoSuchElementException. Since 1.2.0 prefer orElseThrow() method as it has readable name.
    
    Returns:
    
    the value held by this OptionalInt
    
    Throws:
    
    java.util.NoSuchElementException - if there is no value present
    
    See Also:
    
    isPresent(), orElseThrow()
  - isPresent
```
public boolean isPresent()
```
    Return true if there is a value present, otherwise false.
    
    Returns:
    
    true if there is a value present, otherwise false
  - isEmpty
```
public boolean isEmpty()
```
    Checks the value is not present.
    
    Returns:
    
    true if a value is not present, false otherwise
    
    Since:
    
    1.2.1
  - ifPresent
```
public void ifPresent(@NotNull
                      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(@NotNull
                            IntConsumer consumer,
                            @NotNull
                            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
  - executeIfPresent
```
@NotNull
public OptionalInt executeIfPresent(@NotNull
                                             IntConsumer consumer)
```
    Invokes consumer function with value if present. This method same as ifPresent, but does not break chaining
    
    Parameters:
    
    consumer - consumer function
    
    Returns:
    
    this OptionalInt
    
    Since:
    
    1.1.2
    
    See Also:
    
    ifPresent(com.annimon.stream.function.IntConsumer)
  - executeIfAbsent
```
@NotNull
public OptionalInt executeIfAbsent(@NotNull
                                            java.lang.Runnable action)
```
    Invokes action function if value is absent.
    
    Parameters:
    
    action - action that invokes if value absent
    
    Returns:
    
    this OptionalInt
    
    Since:
    
    1.1.2
  - custom
```
@Nullable
public <R> R custom(@NotNull
                              Function<OptionalInt,R> function)
```
    Applies custom operator on OptionalInt.
    
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    function - a transforming function
    
    Returns:
    
    a result of the transforming function
    
    Throws:
    
    java.lang.NullPointerException - if function is null
    
    Since:
    
    1.1.9
  - filter
```
@NotNull
public OptionalInt filter(@NotNull
                                   IntPredicate predicate)
```
    Performs filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalInt if the value is present and matches predicate, otherwise an empty OptionalInt
    
    Since:
    
    1.1.4
  - filterNot
```
@NotNull
public OptionalInt filterNot(@NotNull
                                      IntPredicate predicate)
```
    Performs negated filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalInt if the value is present and doesn't matches predicate, otherwise an empty OptionalInt
    
    Since:
    
    1.1.9
  - map
```
@NotNull
public OptionalInt map(@NotNull
                                IntUnaryOperator mapper)
```
    Invokes mapping function on inner value if present.
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an OptionalInt with transformed value if present, otherwise an empty OptionalInt
    
    Throws:
    
    java.lang.NullPointerException - if value is present and mapper is null
    
    Since:
    
    1.1.3
  - mapToObj
```
@NotNull
public <U> Optional<U> mapToObj(@NotNull
                                         IntFunction<U> mapper)
```
    Invokes mapping function on inner value if present.
    
    Type Parameters:
    
    U - the type of result value
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an Optional with transformed value if present, otherwise an empty Optional
    
    Throws:
    
    java.lang.NullPointerException - if value is present and mapper is null
    
    Since:
    
    1.1.3
  - mapToLong
```
@NotNull
public OptionalLong mapToLong(@NotNull
                                       IntToLongFunction mapper)
```
    Invokes mapping function on inner value if present.
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an OptionalLong with transformed value if present, otherwise an empty OptionalLong
    
    Throws:
    
    java.lang.NullPointerException - if value is present and mapper is null
    
    Since:
    
    1.1.4
  - mapToDouble
```
@NotNull
public OptionalDouble mapToDouble(@NotNull
                                           IntToDoubleFunction mapper)
```
    Invokes mapping function on inner value if present.
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an OptionalDouble with transformed value if present, otherwise an empty OptionalDouble
    
    Throws:
    
    java.lang.NullPointerException - if value is present and mapper is null
    
    Since:
    
    1.1.4
  - stream
```
@NotNull
public IntStream stream()
```
    Wraps a value into IntStream if present, otherwise returns an empty IntStream.
    
    Returns:
    
    the optional value as an IntStream
  - or
```
@NotNull
public OptionalInt or(@NotNull
                               Supplier<OptionalInt> supplier)
```
    Returns current OptionalInt if value is present, otherwise returns an OptionalInt produced by supplier function.
    
    Parameters:
    
    supplier - supplier function that produces an OptionalInt to be returned
    
    Returns:
    
    this OptionalInt if value is present, otherwise an OptionalInt produced by supplier function
    
    Throws:
    
    java.lang.NullPointerException - if value is not present and supplier or value produced by it is null
  - orElse
```
public int orElse(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
  - orElseGet
```
public int orElseGet(@NotNull
                     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
  - orElseThrow
```
public int orElseThrow()
```
    Returns inner value if present, otherwise throws NoSuchElementException.
    
    Returns:
    
    inner value if present
    
    Throws:
    
    java.util.NoSuchElementException - if inner value is not present
    
    Since:
    
    1.2.0
  - orElseThrow
```
public <X extends java.lang.Throwable> int orElseThrow(@NotNull
                                                       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
```
@NotNull
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

Class OptionalInt

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

ofNullable

getAsInt

isPresent

isEmpty

ifPresent

ifPresentOrElse

executeIfPresent

executeIfAbsent

custom

filter

filterNot

map

mapToObj

mapToLong

mapToDouble

stream

or

orElse

orElseGet

orElseThrow

orElseThrow

equals

hashCode

toString