OptionalInts (Root POM 0.9.18-SNAPSHOT API)

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

```
public final class OptionalInts
extends Object
```
This class contains helper methods for OptionalInt.

Field Summary

Fields
Modifier and Type	Field and Description
`static IntPredicate`	`IS_NEGATIVE` Predicate returning `true` for all values less than zero.
`static IntPredicate`	`IS_NEGATIVE_OR_ZERO` Predicate returning `true` for all values less than or equal to zero.
`static IntPredicate`	`IS_POSITIVE` Predicate returning `true` for all values greater than zero.
`static IntPredicate`	`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<Integer>`	`boxed(OptionalInt optional)` Returns a `Optional` consisting of the elements of `optional`, boxed to an `Integer`.
`static OptionalInt`	`filter(OptionalInt optional, IntPredicate predicate)` If a value is present, and the value matches the given predicate, return an `OptionalInt` describing the value, otherwise return an empty `OptionalInt`.
`static OptionalInt`	`flatMap(OptionalInt optional, IntFunction<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 OptionalDouble`	`flatMapToDouble(OptionalInt optional, IntFunction<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 OptionalLong`	`flatMapToLong(OptionalInt optional, IntFunction<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(OptionalInt optional, IntFunction<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 OptionalInt`	`map(OptionalInt optional, IntToIntFunction mapper)` If a value is present, applies `mapper` to `optional` and returns an `OptionalInt` describing the result.
`static OptionalDouble`	`mapToDouble(OptionalInt optional, IntToDoubleFunction mapper)` If a value is present, applies `mapper` to `optional` and returns an `OptionalDouble` describing the result.
`static OptionalLong`	`mapToLong(OptionalInt optional, IntToLongFunction mapper)` If a value is present, applies `mapper` to `optional` and returns an `OptionalLong` describing the result.
`static <T> Optional<T>`	`mapToObj(OptionalInt optional, IntFunction<T> mapper)` If a value is present, applies `mapper` to `optional` and returns an `Optional` describing the result.
`static OptionalInt`	`ofNon(IntPredicate isEmpty, int value)` Returns an `OptionalInt` describing the specified value, if non-empty, otherwise returns an empty `OptionalInt`.
`static OptionalInt`	`ofNullable(Integer value)` Returns an `OptionalInt` describing the specified value, if non-null, otherwise returns an empty `OptionalInt`.
`static IntStream`	`stream(OptionalInt... 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 IntPredicate IS_NEGATIVE
```
    Predicate returning true for all values less than zero.
  - IS_NEGATIVE_OR_ZERO
```
public static final IntPredicate IS_NEGATIVE_OR_ZERO
```
    Predicate returning true for all values less than or equal to zero.
  - IS_POSITIVE
```
public static final IntPredicate IS_POSITIVE
```
    Predicate returning true for all values greater than zero.
  - IS_POSITIVE_OR_ZERO
```
public static final IntPredicate IS_POSITIVE_OR_ZERO
```
    Predicate returning true for all values greater than or equal to zero.
- Method Detail
  - boxed
```
public static Optional<Integer> boxed(OptionalInt optional)
```
    Returns a Optional consisting of the elements of optional, boxed to an Integer.
    
    Parameters:
    
    optional - optional value
    
    Returns:
    
    a Optional consistent of the elements of optional, boxed to an Integer
  - filter
```
public static OptionalInt filter(OptionalInt optional,
                                 IntPredicate predicate)
```
    If a value is present, and the value matches the given predicate, return an OptionalInt describing the value, otherwise return an empty OptionalInt.
    
    Parameters:
    
    optional - optional value
    
    predicate - a predicate to apply to the value, if present
    
    Returns:
    
    an OptionalInt describing the value of optional if a value is present and the value matches the given predicate, otherwise an empty OptionalInt
  - flatMap
```
public static OptionalInt flatMap(OptionalInt optional,
                                  IntFunction<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 map(OptionalInt, IntToIntFunction), 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
  - flatMapToDouble
```
public static OptionalDouble flatMapToDouble(OptionalInt optional,
                                             IntFunction<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 mapToDouble(OptionalInt, IntToDoubleFunction), 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
  - flatMapToLong
```
public static OptionalLong flatMapToLong(OptionalInt optional,
                                         IntFunction<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(OptionalInt, IntToLongFunction), 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(OptionalInt optional,
                                           IntFunction<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(OptionalInt, IntFunction), 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 OptionalInt map(OptionalInt optional,
                              IntToIntFunction 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
  - mapToDouble
```
public static OptionalDouble mapToDouble(OptionalInt optional,
                                         IntToDoubleFunction 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
  - mapToLong
```
public static OptionalLong mapToLong(OptionalInt optional,
                                     IntToLongFunction 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(OptionalInt optional,
                                       IntFunction<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 OptionalInt ofNon(IntPredicate isEmpty,
                                int value)
```
    Returns an OptionalInt describing the specified value, if non-empty, otherwise returns an empty OptionalInt. The term empty is described by isEmpty.
    
    Parameters:
    
    isEmpty - predicate describing the term empty
    
    value - the possibly-empty value to describe
    
    Returns:
    
    an OptionalInt with a present value if the specified value is non-empty, otherwise an empty OptionalInt
  - ofNullable
```
public static OptionalInt ofNullable(@Nullable
                                     Integer value)
```
    Returns an OptionalInt describing the specified value, if non-null, otherwise returns an empty OptionalInt.
    
    Parameters:
    
    value - the possibly-null value to describe
    
    Returns:
    
    an OptionalInt with a present value if the specified value is non-null, otherwise an empty OptionalInt
  - stream
```
@SafeVarargs
public static IntStream stream(OptionalInt... optionals)
```
    Returns a stream consisting of present elements.
    
    Parameters:
    
    optionals - array of optional elements
    
    Returns:
    
    the new stream

Class OptionalInts

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

flatMapToDouble

flatMapToLong

flatMapToObj

map

mapToDouble

mapToLong

mapToObj

ofNon

ofNullable

stream