OptionalDouble (stream 1.2.2 API)

java.lang.Object
- com.annimon.stream.OptionalDouble

```
public final class OptionalDouble
extends java.lang.Object
```
A container object which may or may not contain a double value.

Since:

1.1.4

See Also:

Optional

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`custom(Function<OptionalDouble,R> function)` Applies custom operator on `OptionalDouble`.
`static OptionalDouble`	`empty()` Returns an empty `OptionalDouble` instance.
`boolean`	`equals(java.lang.Object obj)`
`OptionalDouble`	`executeIfAbsent(java.lang.Runnable action)` Invokes action function if value is absent.
`OptionalDouble`	`executeIfPresent(DoubleConsumer consumer)` Invokes consumer function with the value if present.
`OptionalDouble`	`filter(DoublePredicate predicate)` Performs filtering on inner value if it is present.
`OptionalDouble`	`filterNot(DoublePredicate predicate)` Performs negated filtering on inner value if it is present.
`double`	`getAsDouble()` Returns an inner value if present, otherwise throws `NoSuchElementException`.
`int`	`hashCode()`
`void`	`ifPresent(DoubleConsumer consumer)` Invokes consumer function with value if present, otherwise does nothing.
`void`	`ifPresentOrElse(DoubleConsumer 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()` Checks value present.
`OptionalDouble`	`map(DoubleUnaryOperator mapper)` Invokes the given mapping function on inner value if present.
`OptionalInt`	`mapToInt(DoubleToIntFunction mapper)` Invokes the given mapping function on inner value if present.
`OptionalLong`	`mapToLong(DoubleToLongFunction mapper)` Invokes the given mapping function on inner value if present.
`<U> Optional<U>`	`mapToObj(DoubleFunction<U> mapper)` Invokes the given mapping function on inner value if present.
`static OptionalDouble`	`of(double value)` Returns an `OptionalDouble` with the specified value present.
`static OptionalDouble`	`ofNullable(java.lang.Double value)` Returns an `OptionalDouble` with the specified value, or empty `OptionalDouble` if value is null.
`OptionalDouble`	`or(Supplier<OptionalDouble> supplier)` Returns current `OptionalDouble` if value is present, otherwise returns an `OptionalDouble` produced by supplier function.
`double`	`orElse(double other)` Returns inner value if present, otherwise returns `other`.
`double`	`orElseGet(DoubleSupplier other)` Returns the value if present, otherwise returns value produced by supplier function.
`double`	`orElseThrow()` Returns inner value if present, otherwise throws `NoSuchElementException`.
`<X extends java.lang.Throwable> double`	`orElseThrow(Supplier<X> exceptionSupplier)` Returns the value if present, otherwise throws an exception provided by supplier function.
`DoubleStream`	`stream()` Wraps a value into `DoubleStream` if present, otherwise returns an empty `DoubleStream`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - empty
```
@NotNull
public static OptionalDouble empty()
```
    Returns an empty OptionalDouble instance.
    
    Returns:
    
    an empty OptionalDouble
  - of
```
@NotNull
public static OptionalDouble of(double value)
```
    Returns an OptionalDouble with the specified value present.
    
    Parameters:
    
    value - the value to be present
    
    Returns:
    
    an OptionalDouble with the value present
  - ofNullable
```
@NotNull
public static OptionalDouble ofNullable(@Nullable
                                                 java.lang.Double value)
```
    Returns an OptionalDouble with the specified value, or empty OptionalDouble if value is null.
    
    Parameters:
    
    value - the value which can be null
    
    Returns:
    
    an OptionalDouble
    
    Since:
    
    1.2.1
  - getAsDouble
```
public double getAsDouble()
```
    Returns an inner value if present, otherwise throws NoSuchElementException. Since 1.2.0 prefer orElseThrow() method as it has readable name.
    
    Returns:
    
    the inner value of this OptionalDouble
    
    Throws:
    
    java.util.NoSuchElementException - if there is no value present
    
    See Also:
    
    isPresent(), orElseThrow()
  - isPresent
```
public boolean isPresent()
```
    Checks value present.
    
    Returns:
    
    true if a value present, false otherwise
  - 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
                      DoubleConsumer consumer)
```
    Invokes consumer function with value if present, otherwise does nothing.
    
    Parameters:
    
    consumer - the consumer function 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
                            DoubleConsumer 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.
  - executeIfPresent
```
@NotNull
public OptionalDouble executeIfPresent(@NotNull
                                                DoubleConsumer consumer)
```
    Invokes consumer function with the value if present. This method same as ifPresent, but does not breaks chaining
    
    Parameters:
    
    consumer - consumer function
    
    Returns:
    
    this OptionalDouble
    
    See Also:
    
    ifPresent(com.annimon.stream.function.DoubleConsumer)
  - executeIfAbsent
```
@NotNull
public OptionalDouble executeIfAbsent(@NotNull
                                               java.lang.Runnable action)
```
    Invokes action function if value is absent.
    
    Parameters:
    
    action - action that invokes if value absent
    
    Returns:
    
    this OptionalDouble
  - custom
```
@Nullable
public <R> R custom(@NotNull
                              Function<OptionalDouble,R> function)
```
    Applies custom operator on OptionalDouble.
    
    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 OptionalDouble filter(@NotNull
                                      DoublePredicate predicate)
```
    Performs filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalDouble if the value is present and matches predicate, otherwise an empty OptionalDouble
  - filterNot
```
@NotNull
public OptionalDouble filterNot(@NotNull
                                         DoublePredicate predicate)
```
    Performs negated filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalDouble if the value is present and doesn't matches predicate, otherwise an empty OptionalDouble
    
    Since:
    
    1.1.9
  - map
```
@NotNull
public OptionalDouble map(@NotNull
                                   DoubleUnaryOperator mapper)
```
    Invokes the given 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
  - mapToObj
```
@NotNull
public <U> Optional<U> mapToObj(@NotNull
                                         DoubleFunction<U> mapper)
```
    Invokes the given 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
  - mapToInt
```
@NotNull
public OptionalInt mapToInt(@NotNull
                                     DoubleToIntFunction mapper)
```
    Invokes the given 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
  - mapToLong
```
@NotNull
public OptionalLong mapToLong(@NotNull
                                       DoubleToLongFunction mapper)
```
    Invokes the given 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
  - stream
```
@NotNull
public DoubleStream stream()
```
    Wraps a value into DoubleStream if present, otherwise returns an empty DoubleStream.
    
    Returns:
    
    the optional value as an DoubleStream
  - or
```
@NotNull
public OptionalDouble or(@NotNull
                                  Supplier<OptionalDouble> supplier)
```
    Returns current OptionalDouble if value is present, otherwise returns an OptionalDouble produced by supplier function.
    
    Parameters:
    
    supplier - supplier function that produces an OptionalDouble to be returned
    
    Returns:
    
    this OptionalDouble if value is present, otherwise an OptionalDouble produced by supplier function
    
    Throws:
    
    java.lang.NullPointerException - if value is not present and supplier or value produced by it is null
  - orElse
```
public double orElse(double other)
```
    Returns inner 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 double orElseGet(@NotNull
                        DoubleSupplier other)
```
    Returns the value if present, otherwise returns value produced by supplier function.
    
    Parameters:
    
    other - supplier function that produces value if inner value is not present
    
    Returns:
    
    the value if present otherwise the result of other.getAsDouble()
    
    Throws:
    
    java.lang.NullPointerException - if value is not present and other is null
  - orElseThrow
```
public double 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> double 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)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
@NotNull
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class OptionalDouble

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

ofNullable

getAsDouble

isPresent

isEmpty

ifPresent

ifPresentOrElse

executeIfPresent

executeIfAbsent

custom

filter

filterNot

map

mapToObj

mapToInt

mapToLong

stream

or

orElse

orElseGet

orElseThrow

orElseThrow

equals

hashCode

toString