OptionalLong (stream 1.2.2 API)

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

```
public final class OptionalLong
extends java.lang.Object
```
A container object which may or may not contain a long 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<OptionalLong,R> function)` Applies custom operator on `OptionalLong`.
`static OptionalLong`	`empty()` Returns an empty `OptionalLong` instance.
`boolean`	`equals(java.lang.Object obj)`
`OptionalLong`	`executeIfAbsent(java.lang.Runnable action)` Invokes action function if value is absent.
`OptionalLong`	`executeIfPresent(LongConsumer consumer)` Invokes consumer function with the value if present.
`OptionalLong`	`filter(LongPredicate predicate)` Performs filtering on inner value if it is present.
`OptionalLong`	`filterNot(LongPredicate predicate)` Performs negated filtering on inner value if it is present.
`long`	`getAsLong()` Returns an inner value if present, otherwise throws `NoSuchElementException`.
`int`	`hashCode()`
`void`	`ifPresent(LongConsumer consumer)` Invokes consumer function with value if present, otherwise does nothing.
`void`	`ifPresentOrElse(LongConsumer 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.
`OptionalLong`	`map(LongUnaryOperator mapper)` Invokes the given mapping function on inner value if present.
`OptionalInt`	`mapToInt(LongToIntFunction mapper)` Invokes the given mapping function on inner value if present.
`<U> Optional<U>`	`mapToObj(LongFunction<U> mapper)` Invokes the given mapping function on inner value if present.
`static OptionalLong`	`of(long value)` Returns an `OptionalLong` with the specified value present.
`static OptionalLong`	`ofNullable(java.lang.Long value)` Returns an `OptionalLong` with the specified value, or empty `OptionalLong` if value is null.
`OptionalLong`	`or(Supplier<OptionalLong> supplier)` Returns current `OptionalLong` if value is present, otherwise returns an `OptionalLong` produced by supplier function.
`long`	`orElse(long other)` Returns inner value if present, otherwise returns `other`.
`long`	`orElseGet(LongSupplier other)` Returns the value if present, otherwise returns value produced by supplier function.
`long`	`orElseThrow()` Returns inner value if present, otherwise throws `NoSuchElementException`.
`<X extends java.lang.Throwable> long`	`orElseThrow(Supplier<X> exceptionSupplier)` Returns the value if present, otherwise throws an exception provided by supplier function.
`LongStream`	`stream()` Wraps a value into `LongStream` if present, otherwise returns an empty `LongStream`.
`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 OptionalLong empty()
```
    Returns an empty OptionalLong instance.
    
    Returns:
    
    an empty OptionalLong
  - of
```
@NotNull
public static OptionalLong of(long value)
```
    Returns an OptionalLong with the specified value present.
    
    Parameters:
    
    value - the value to be present
    
    Returns:
    
    an OptionalLong with the value present
  - ofNullable
```
@NotNull
public static OptionalLong ofNullable(@Nullable
                                               java.lang.Long value)
```
    Returns an OptionalLong with the specified value, or empty OptionalLong if value is null.
    
    Parameters:
    
    value - the value which can be null
    
    Returns:
    
    an OptionalLong
    
    Since:
    
    1.2.1
  - getAsLong
```
public long getAsLong()
```
    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 OptionalLong
    
    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
                      LongConsumer 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
                            LongConsumer 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 OptionalLong executeIfPresent(@NotNull
                                              LongConsumer 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 OptionalLong
    
    See Also:
    
    ifPresent(com.annimon.stream.function.LongConsumer)
  - executeIfAbsent
```
@NotNull
public OptionalLong executeIfAbsent(@NotNull
                                             java.lang.Runnable action)
```
    Invokes action function if value is absent.
    
    Parameters:
    
    action - action that invokes if value absent
    
    Returns:
    
    this OptionalLong
  - custom
```
@Nullable
public <R> R custom(@NotNull
                              Function<OptionalLong,R> function)
```
    Applies custom operator on OptionalLong.
    
    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 OptionalLong filter(@NotNull
                                    LongPredicate predicate)
```
    Performs filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalLong if the value is present and matches predicate, otherwise an empty OptionalLong
  - filterNot
```
@NotNull
public OptionalLong filterNot(@NotNull
                                       LongPredicate predicate)
```
    Performs negated filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalLong if the value is present and doesn't matches predicate, otherwise an empty OptionalLong
    
    Since:
    
    1.1.9
  - map
```
@NotNull
public OptionalLong map(@NotNull
                                 LongUnaryOperator 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
  - mapToObj
```
@NotNull
public <U> Optional<U> mapToObj(@NotNull
                                         LongFunction<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
                                     LongToIntFunction 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
  - stream
```
@NotNull
public LongStream stream()
```
    Wraps a value into LongStream if present, otherwise returns an empty LongStream.
    
    Returns:
    
    the optional value as an LongStream
  - or
```
@NotNull
public OptionalLong or(@NotNull
                                Supplier<OptionalLong> supplier)
```
    Returns current OptionalLong if value is present, otherwise returns an OptionalLong produced by supplier function.
    
    Parameters:
    
    supplier - supplier function that produces an OptionalLong to be returned
    
    Returns:
    
    this OptionalLong if value is present, otherwise an OptionalLong produced by supplier function
    
    Throws:
    
    java.lang.NullPointerException - if value is not present and supplier or value produced by it is null
  - orElse
```
public long orElse(long 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 long orElseGet(@NotNull
                      LongSupplier 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.getAsLong()
    
    Throws:
    
    java.lang.NullPointerException - if value is not present and other is null
  - orElseThrow
```
public long 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> long 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 OptionalLong

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

ofNullable

getAsLong

isPresent

isEmpty

ifPresent

ifPresentOrElse

executeIfPresent

executeIfAbsent

custom

filter

filterNot

map

mapToObj

mapToInt

stream

or

orElse

orElseGet

orElseThrow

orElseThrow

equals

hashCode

toString