Package org.storynode.pigeon.option

Class Some<T>

java.lang.Object
org.storynode.pigeon.option.Option<T>
org.storynode.pigeon.option.Some<T>
All Implemented Interfaces:
SafelyWrapped<T>, Wrapped<T>
public class Some<T> extends Option<T>
An Option with some value in it.
Author:
Andrea Coronese
See Also:

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Some(T value)
    Creates an Option that has a non-null value in it

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Option<T>
    filter(Predicate<? super T> predicate)
    If a value is present, and the value matches the given predicate, returns an Option describing the value, otherwise returns an empty Option.
    <U> Option<U>
    flatMap(@NotNull Function<? super T,? extends Option<? extends U>> mapper)
    If a value is present, returns the result of applying the given Optional-bearing mapping function to the value, otherwise returns an empty Optional.
    int
    hashCode()
    void
    ifPresent(@NotNull Consumer<T> func)
    Executes func if this is Some, consuming the contained value.
    void
    ifPresentOrElse(@NotNull Consumer<T> whenPresent, Runnable otherwise)
    Executes whenPresent if this is Some, consuming the contained value, or runs otherwise if this is None
    boolean
    isSome()
    Whether this option contains a value or not
    <U> Option<U>
    map(@NotNull Function<T,U> mapper)
    If a value is present, returns an Option describing (as if by Option.some(T)) the result of applying the given mapping function to the value, otherwise returns an empty Option.
    Option<? extends T>
    or(@NotNull Supplier<? extends Option<? extends T>> supplier)
    If a value is present, returns an Option describing the value, otherwise returns an Option produced by the given supplying function
    T
    orElse(T other)
    If a value is present, returns the value, otherwise returns other.
    T
    orElseGet(@NotNull Supplier<T> supplier)
    If a value is present, returns the value, otherwise returns the result produced by the supplying function.
    T
    orElseThrow()
    If a value is present returns that value, otherwise throws NoSuchElementException.
    <E extends Throwable>
    T
    orElseThrow(@NotNull Supplier<E> throwable)
    If a value is present returns that value, otherwise throws the supplied Throwable.
    Stream<T>
    stream()
    Streams the contained value, if any.
    String
    toString()
    T
    unwrap()
    Gets the wrapped value.
    T
    value()
    Returns the contained value

    Methods inherited from class org.storynode.pigeon.option.Option

    isNone, none, of, of, some

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.storynode.pigeon.protocol.SafelyWrapped

    tryUnwrap

  • Constructor Details

    • Some

      protected Some(@NonNull T value)
      Creates an Option that has a non-null value in it
      Parameters:
      value - The inner value

  • Method Details

    • isSome

      public boolean isSome()
      Whether this option contains a value or not
      Specified by:
      isSome in class Option<T>
      Returns:
      true if this contains a value, false otherwise
      See Also:

    • ifPresent

      public void ifPresent(@NotNull @NotNull Consumer<T> func)
      Executes func if this is Some, consuming the contained value.
      Specified by:
      ifPresent in class Option<T>
      Parameters:
      func - The function to execute

    • ifPresentOrElse

      public void ifPresentOrElse(@NotNull @NotNull Consumer<T> whenPresent, Runnable otherwise)
      Executes whenPresent if this is Some, consuming the contained value, or runs otherwise if this is None
      Specified by:
      ifPresentOrElse in class Option<T>
      Parameters:
      whenPresent - The function to execute if this is Some
      otherwise - The function to execute if this is None

    • filter

      public Option<T> filter(Predicate<? super T> predicate)
      If a value is present, and the value matches the given predicate, returns an Option describing the value, otherwise returns an empty Option.
      Specified by:
      filter in class Option<T>
      Parameters:
      predicate - the predicate to apply to a value, if present
      Returns:
      an Option describing the value of this Option, if a value is present and the value matches the given predicate, otherwise an empty Option

    • map

      public <U> Option<U> map(@NotNull @NotNull Function<T,U> mapper)
      If a value is present, returns an Option describing (as if by Option.some(T)) the result of applying the given mapping function to the value, otherwise returns an empty Option.

      If the mapping function returns a null result then this method returns an empty Option.

      Specified by:
      map in class Option<T>
      Type Parameters:
      U - The type of the value returned from the mapping function
      Parameters:
      mapper - the mapping function to apply to a value, if present
      Returns:
      an Option describing the result of applying a mapping function to the value of this Option, if a value is present, otherwise an empty Option

    • flatMap

      public <U> Option<U> flatMap(@NotNull @NotNull Function<? super T,? extends Option<? extends U>> mapper)
      If a value is present, returns the result of applying the given Optional-bearing mapping function to the value, otherwise returns an empty Optional.

      This method is similar to Option.map(Function), but the mapping function is one whose result is already an Optional, and if invoked, flatMap does not wrap it within an additional Optional.

      Specified by:
      flatMap in class Option<T>
      Type Parameters:
      U - The type of value of the Optional returned by the mapping function
      Parameters:
      mapper - the mapping function to apply to a value, if present
      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

    • or

      public Option<? extends T> or(@NotNull @NotNull Supplier<? extends Option<? extends T>> supplier)
      Description copied from class: Option
      If a value is present, returns an Option describing the value, otherwise returns an Option produced by the given supplying function
      Specified by:
      or in class Option<T>
      Parameters:
      supplier - The supplier that produces the Option in case a value is not present in this
      Returns:
      An Option with the value of this, if any is present, or another Option supplied by the provided supplying function

    • orElseGet

      public T orElseGet(@NotNull @NotNull Supplier<T> supplier)
      If a value is present, returns the value, otherwise returns the result produced by the supplying function.
      Specified by:
      orElseGet in class Option<T>
      Parameters:
      supplier - the supplying function that produces a value to be returned
      Returns:
      the value, if present, otherwise the result produced by the supplying function

    • orElse

      public T orElse(T other)
      If a value is present, returns the value, otherwise returns other.
      Specified by:
      orElse in class Option<T>
      Parameters:
      other - the value to be returned, if no value is present. May be null.
      Returns:
      the value, if present, otherwise other

    • orElseThrow

      public T orElseThrow()
      If a value is present returns that value, otherwise throws NoSuchElementException.

      Please note that this is mainly for API compatibility with Optional but should be avoided in favour of Option.orElse(Object) and Option.orElseGet(Supplier)

      Specified by:
      orElseThrow in class Option<T>
      Returns:
      The contained value, if present

    • orElseThrow

      public <E extends Throwable> T orElseThrow(@NotNull @NotNull Supplier<E> throwable)
      If a value is present returns that value, otherwise throws the supplied Throwable.

      Please note that this is mainly for API compatibility with Optional but should be avoided in favour of Option.orElse(Object) and Option.orElseGet(Supplier)

      Specified by:
      orElseThrow in class Option<T>
      Type Parameters:
      E - The concrete type of the Throwable
      Parameters:
      throwable - The function that supplies the exception to throw
      Returns:
      a T object

    • stream

      public Stream<T> stream()
      Streams the contained value, if any.
      Specified by:
      stream in class Option<T>
      Returns:
      a Stream object

    • value

      public T value()
      Returns the contained value
      Returns:
      The contained value
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • unwrap

      public T unwrap()
      Gets the wrapped value. This method is allowed to throw a UnwrapException if the specific implementors requires so.
      If you need a non-throwing version of unwrap use tryUnwrap.
      Returns:
      The wrapped value
      Throws:
      UnwrapException - if this Option is None.
      See Also: