OptionalDoubles (Root POM 0.9.18-SNAPSHOT API)

java.lang.Object
- de.larssh.utils.OptionalDoubles

```
public final class OptionalDoubles
extends Object
```
This class contains helper methods for OptionalDouble.

Field Summary

Fields
Modifier and Type	Field and Description
`static DoublePredicate`	`IS_NEGATIVE` Predicate returning `true` for all values less than zero.
`static DoublePredicate`	`IS_NEGATIVE_OR_ZERO` Predicate returning `true` for all values less than or equal to zero.
`static DoublePredicate`	`IS_POSITIVE` Predicate returning `true` for all values greater than zero.
`static DoublePredicate`	`IS_POSITIVE_OR_ZERO` Predicate returning `true` for all values greater than or equal to zero.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Optional<Double>`	`boxed(OptionalDouble optional)` Returns a `Optional` consisting of the elements of `optional`, boxed to a `Double`.
`static OptionalDouble`	`filter(OptionalDouble optional, DoublePredicate predicate)` If a value is present, and the value matches the given predicate, return an `OptionalDouble` describing the value, otherwise return an empty `OptionalDouble`.
`static OptionalDouble`	`flatMap(OptionalDouble optional, DoubleFunction<OptionalDouble> mapper)` If a value is present, apply the provided `OptionalDouble`-bearing mapping function to it, return that result, otherwise return an empty `OptionalDouble`.
`static OptionalInt`	`flatMapToInt(OptionalDouble optional, DoubleFunction<OptionalInt> mapper)` If a value is present, apply the provided `OptionalInt`-bearing mapping function to it, return that result, otherwise return an empty `OptionalInt`.
`static OptionalLong`	`flatMapToLong(OptionalDouble optional, DoubleFunction<OptionalLong> mapper)` If a value is present, apply the provided `OptionalLong`-bearing mapping function to it, return that result, otherwise return an empty `OptionalLong`.
`static <T> Optional<T>`	`flatMapToObj(OptionalDouble optional, DoubleFunction<Optional<T>> mapper)` If a value is present, apply the provided `Optional`-bearing mapping function to it, return that result, otherwise return an empty `Optional`.
`static OptionalDouble`	`map(OptionalDouble optional, DoubleToDoubleFunction mapper)` If a value is present, applies `mapper` to `optional` and returns an `OptionalDouble` describing the result.
`static OptionalInt`	`mapToInt(OptionalDouble optional, DoubleToIntFunction mapper)` If a value is present, applies `mapper` to `optional` and returns an `OptionalInt` describing the result.
`static OptionalLong`	`mapToLong(OptionalDouble optional, DoubleToLongFunction mapper)` If a value is present, applies `mapper` to `optional` and returns an `OptionalLong` describing the result.
`static <T> Optional<T>`	`mapToObj(OptionalDouble optional, DoubleFunction<T> mapper)` If a value is present, applies `mapper` to `optional` and returns an `Optional` describing the result.
`static OptionalDouble`	`ofNon(DoublePredicate isEmpty, double value)` Returns an `OptionalDouble` describing the specified value, if non-empty, otherwise returns an empty `OptionalDouble`.
`static OptionalDouble`	`ofNullable(Double value)` Returns an `OptionalDouble` describing the specified value, if non-null, otherwise returns an empty `OptionalDouble`.
`static DoubleStream`	`stream(OptionalDouble... optionals)` Returns a stream consisting of present elements.

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

- Field Detail
  - IS_NEGATIVE
```
public static final DoublePredicate IS_NEGATIVE
```
    Predicate returning true for all values less than zero.
  - IS_NEGATIVE_OR_ZERO
```
public static final DoublePredicate IS_NEGATIVE_OR_ZERO
```
    Predicate returning true for all values less than or equal to zero.
  - IS_POSITIVE
```
public static final DoublePredicate IS_POSITIVE
```
    Predicate returning true for all values greater than zero.
  - IS_POSITIVE_OR_ZERO
```
public static final DoublePredicate IS_POSITIVE_OR_ZERO
```
    Predicate returning true for all values greater than or equal to zero.
- Method Detail
  - boxed
```
public static Optional<Double> boxed(OptionalDouble optional)
```
    Returns a Optional consisting of the elements of optional, boxed to a Double.
    
    Parameters:
    
    optional - optional value
    
    Returns:
    
    a Optional consistent of the elements of optional, boxed to a Double
  - filter
```
public static OptionalDouble filter(OptionalDouble optional,
                                    DoublePredicate predicate)
```
    If a value is present, and the value matches the given predicate, return an OptionalDouble describing the value, otherwise return an empty OptionalDouble.
    
    Parameters:
    
    optional - optional value
    
    predicate - a predicate to apply to the value, if present
    
    Returns:
    
    an OptionalDouble describing the value of optional if a value is present and the value matches the given predicate, otherwise an empty OptionalDouble
  - flatMap
```
public static OptionalDouble flatMap(OptionalDouble optional,
                                     DoubleFunction<OptionalDouble> mapper)
```
    If a value is present, apply the provided OptionalDouble-bearing mapping function to it, return that result, otherwise return an empty OptionalDouble. This method is similar to map(OptionalDouble, DoubleToDoubleFunction), but the provided mapper is one whose result is already an OptionalDouble, and if invoked, flatMapToDouble does not wrap it with an additional OptionalDouble.
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present the mapping function
    
    Returns:
    
    the result of applying an OptionalDouble-bearing mapping function to the value of this OptionalDouble, if a value is present, otherwise an empty OptionalDouble
  - flatMapToInt
```
public static OptionalInt flatMapToInt(OptionalDouble optional,
                                       DoubleFunction<OptionalInt> mapper)
```
    If a value is present, apply the provided OptionalInt-bearing mapping function to it, return that result, otherwise return an empty OptionalInt. This method is similar to mapToInt(OptionalDouble, DoubleToIntFunction), but the provided mapper is one whose result is already an OptionalInt, and if invoked, flatMap does not wrap it with an additional OptionalInt.
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present the mapping function
    
    Returns:
    
    the result of applying an OptionalInt-bearing mapping function to the value of this OptionalInt, if a value is present, otherwise an empty OptionalInt
  - flatMapToLong
```
public static OptionalLong flatMapToLong(OptionalDouble optional,
                                         DoubleFunction<OptionalLong> mapper)
```
    If a value is present, apply the provided OptionalLong-bearing mapping function to it, return that result, otherwise return an empty OptionalLong. This method is similar to mapToLong(OptionalDouble, DoubleToLongFunction), but the provided mapper is one whose result is already an OptionalLong, and if invoked, flatMapToDouble does not wrap it with an additional OptionalLong.
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present the mapping function
    
    Returns:
    
    the result of applying an OptionalLong-bearing mapping function to the value of this OptionalLong, if a value is present, otherwise an empty OptionalLong
  - flatMapToObj
```
public static <T> Optional<T> flatMapToObj(OptionalDouble optional,
                                           DoubleFunction<Optional<T>> mapper)
```
    If a value is present, apply the provided Optional-bearing mapping function to it, return that result, otherwise return an empty Optional. This method is similar to mapToObj(OptionalDouble, DoubleFunction), but the provided mapper is one whose result is already an Optional, and if invoked, flatMapToDouble does not wrap it with an additional Optional.
    
    Type Parameters:
    
    T - the type parameter to the Optional returned
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present the mapping function
    
    Returns:
    
    the result of applying an Optional-bearing mapping function to the value of this Optional, if a value is present, otherwise an empty Optional
  - map
```
public static OptionalDouble map(OptionalDouble optional,
                                 DoubleToDoubleFunction mapper)
```
    If a value is present, applies mapper to optional and returns an OptionalDouble describing the result. Otherwise returns an empty OptionalDouble.
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present
    
    Returns:
    
    an OptionalDouble describing the result of applying mapper function to the value of optional, if a value is present, otherwise an empty OptionalDouble
  - mapToInt
```
public static OptionalInt mapToInt(OptionalDouble optional,
                                   DoubleToIntFunction mapper)
```
    If a value is present, applies mapper to optional and returns an OptionalInt describing the result. Otherwise returns an empty OptionalInt.
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present
    
    Returns:
    
    an OptionalInt describing the result of applying mapper function to the value of optional, if a value is present, otherwise an empty OptionalInt
  - mapToLong
```
public static OptionalLong mapToLong(OptionalDouble optional,
                                     DoubleToLongFunction mapper)
```
    If a value is present, applies mapper to optional and returns an OptionalLong describing the result. Otherwise returns an empty OptionalLong.
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present
    
    Returns:
    
    an OptionalLong describing the result of applying mapper function to the value of optional, if a value is present, otherwise an empty OptionalLong
  - mapToObj
```
public static <T> Optional<T> mapToObj(OptionalDouble optional,
                                       DoubleFunction<T> mapper)
```
    If a value is present, applies mapper to optional and returns an Optional describing the result. Otherwise returns an empty Optional.
    
    Type Parameters:
    
    T - the type of the result of mapper
    
    Parameters:
    
    optional - optional value
    
    mapper - a mapping function to apply to the value, if present
    
    Returns:
    
    an Optional describing the result of applying mapper function to the value of optional, if a value is present, otherwise an empty Optional
  - ofNon
```
public static OptionalDouble ofNon(DoublePredicate isEmpty,
                                   double value)
```
    Returns an OptionalDouble describing the specified value, if non-empty, otherwise returns an empty OptionalDouble. The term empty is described by isEmpty.
    
    Parameters:
    
    isEmpty - predicate describing the term empty
    
    value - the possibly-empty value to describe
    
    Returns:
    
    an OptionalDouble with a present value if the specified value is non-empty, otherwise an empty OptionalDouble
  - ofNullable
```
public static OptionalDouble ofNullable(@Nullable
                                        Double value)
```
    Returns an OptionalDouble describing the specified value, if non-null, otherwise returns an empty OptionalDouble.
    
    Parameters:
    
    value - the possibly-null value to describe
    
    Returns:
    
    an OptionalDouble with a present value if the specified value is non-null, otherwise an empty OptionalDouble
  - stream
```
@SafeVarargs
public static DoubleStream stream(OptionalDouble... optionals)
```
    Returns a stream consisting of present elements.
    
    Parameters:
    
    optionals - array of optional elements
    
    Returns:
    
    the new stream

Class OptionalDoubles

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IS_NEGATIVE

IS_NEGATIVE_OR_ZERO

IS_POSITIVE

IS_POSITIVE_OR_ZERO

Method Detail

boxed

filter

flatMap

flatMapToInt

flatMapToLong

flatMapToObj

map

mapToInt

mapToLong

mapToObj

ofNon

ofNullable

stream