OptionalInt (stream 1.1.3-SNAPSHOT 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
`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.
`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)` 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`.
`OptionalInt`	`map(IntUnaryOperator 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.
`OptionalInt`	`or(Supplier<OptionalInt> supplier)` Returns current `OptionalInt` if value is present, otherwise returns an `Optional` produced by supplier function.
`int`	`orElse(int other)` Return the value if present, otherwise return `other`.
`int`	`orElseGet(IntSupplier other)` Return the value if present, otherwise invoke `other` and return the result of that invocation.
`<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
```
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
  - getAsInt
```
public int getAsInt()
```
    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)
```
    Have the specified consumer accept the value if a value is present, otherwise do nothing.
    
    Parameters:
    
    consumer - block to be executed if a value is present
    
    Throws:
    
    java.lang.NullPointerException - if value is present and consumer is null
  - executeIfPresent
```
public OptionalInt executeIfPresent(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
```
public OptionalInt executeIfAbsent(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
  - map
```
public OptionalInt map(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
    
    Since:
    
    1.1.3
  - mapToObj
```
public <U> Optional<U> mapToObj(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
    
    Since:
    
    1.1.3
  - 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 OptionalInt or(Supplier<OptionalInt> supplier)
```
    Returns current OptionalInt if value is present, otherwise returns an Optional produced by supplier function.
    
    Parameters:
    
    supplier - supplier function that produced 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)
```
    Return the value if present, otherwise return 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(IntSupplier other)
```
    Return the value if present, otherwise invoke other and return 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 <X extends java.lang.Throwable> int orElseThrow(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 produced 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

Class OptionalInt

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

getAsInt

isPresent

ifPresent

executeIfPresent

executeIfAbsent

map

mapToObj

stream

or

orElse

orElseGet

orElseThrow

equals

hashCode

toString