Package com.terheyden.value

Class Value1<C>

java.lang.Object
com.terheyden.value.Value1<C>
public final class Value1<C> extends Object
A stack with a single value. Create via static methods in the ValueStack class.

  • Method Summary

    Modifier and Type
    Method
    Description
    <D> Value2<C,D>
    andOf(D value)
    Adds an additional Value to track, resulting in a new Value2.
    <D> Value2<C,D>
    andOf(io.vavr.CheckedFunction1<? super C,? extends D> valueFunction)
    Uses the existing value, if present, to create a new value to track.
    <D> Value2<C,D>
    andOf(Optional<? extends D> optValue)
    Adds an additional Value to track, resulting in a new Value2.
    <D> Value2<C,D>
    andOfNullable(D value)
    Returns an Value1 describing the given value, if non-null, otherwise returns an empty Value1.
    <D> Value2<C,D>
    andOfNullable(io.vavr.CheckedFunction1<? super C,? extends D> valueFunction)
    Uses the existing value, if present, to create a new value to track.
    static <X> Value1<X>
    empty()
    Returns an empty Value1 instance.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this Value1.
    Value1<C>
    filter(io.vavr.CheckedPredicate<? super C> predicate)
    If a value is present, and the value matches the given predicate, returns an Value1 describing the value, otherwise returns an empty Value1.
    <U> Value1<U>
    flatMap(io.vavr.CheckedFunction1<? super C,? extends Optional<? extends U>> mapper)
    If a value is present, returns the result of applying the given Value1-bearing mapping function to the value, otherwise returns an empty Value1.
    C
    get()
    If a value is present, returns the value, otherwise throws NoSuchElementException.
    int
    hashCode()
    Returns the hash code of the value, if present, otherwise 0 (zero) if no value is present.
    Value1<C>
    ifEmpty(io.vavr.CheckedRunnable emptyAction)
    Performs the empty-based action if no value is present, otherwise does nothing.
    Value1<C>
    ifPresent(io.vavr.CheckedConsumer<? super C> action)
    If a value is present, performs the given action with the value, otherwise does nothing.
    Value1<C>
    ifPresentOrElse(io.vavr.CheckedConsumer<? super C> action, io.vavr.CheckedRunnable emptyAction)
    If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
    boolean
    isEmpty()
    If a value is not present, returns true, otherwise false.
    boolean
    isPresent()
    If a value is present, returns true, otherwise false.
    <U> Value1<U>
    map(io.vavr.CheckedFunction1<? super C,? extends U> mapper)
    If a value is present, returns an Value1 describing (as if by #ofNullable) the result of applying the given mapping function to the value, otherwise returns an empty Value1.
    Value1<C>
    or(C useIfEmpty)
    If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
    Value1<C>
    or(Value1<? extends C> useIfEmpty)
    If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
    Value1<C>
    or(io.vavr.CheckedFunction0<? extends Optional<? extends C>> supplier)
    If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
    Value1<C>
    or(Optional<? extends C> useIfEmpty)
    If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
    C
    orElse(C other)
    If a value is present, returns the value, otherwise returns other.
    C
    orElseGet(Supplier<? extends C> supplier)
    If a value is present, returns the value, otherwise returns the result produced by the supplying function.
    C
    orElseThrow()
    If a value is present, returns the value, otherwise throws NoSuchElementException.
    <X extends Throwable>
    C
    orElseThrow(io.vavr.CheckedFunction0<? extends X> exceptionSupplier)
    If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
    Stream<C>
    stream()
    If a value is present, returns a sequential Stream containing only that value, otherwise returns an empty Stream.
    Optional<C>
    toOptional()
    Converts the last value to a Java Optional.
    String
    toString()
    Returns a non-empty string representation of this Value1 suitable for debugging.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • empty

      public static <X> Value1<X> empty()
      Returns an empty Value1 instance. No value is present for this Value1.
      Type Parameters:
      X - The type of the non-existent value
      Returns:
      an empty Value1

    • andOf

      public <D> Value2<C,D> andOf(D value)
      Adds an additional Value to track, resulting in a new Value2.

    • andOf

      public <D> Value2<C,D> andOf(Optional<? extends D> optValue)
      Adds an additional Value to track, resulting in a new Value2.

    • andOf

      public <D> Value2<C,D> andOf(io.vavr.CheckedFunction1<? super C,? extends D> valueFunction)
      Uses the existing value, if present, to create a new value to track. If the existing value is empty, then an empty Value2 is returned.

    • andOfNullable

      public <D> Value2<C,D> andOfNullable(@Nullable D value)
      Returns an Value1 describing the given value, if non-null, otherwise returns an empty Value1.
      Type Parameters:
      D - the type of the value
      Parameters:
      value - the possibly-null value to describe
      Returns:
      an Value1 with a present value if the specified value is non-null, otherwise an empty Value1

    • andOfNullable

      public <D> Value2<C,D> andOfNullable(io.vavr.CheckedFunction1<? super C,? extends D> valueFunction)
      Uses the existing value, if present, to create a new value to track. If the existing value is empty, then an empty Value2 is returned.

    • get

      public C get()
      If a value is present, returns the value, otherwise throws NoSuchElementException.
      Returns:
      the non-null value described by this Value1
      Throws:
      NoSuchElementException - if no value is present

    • isPresent

      public boolean isPresent()
      If a value is present, returns true, otherwise false.
      Returns:
      true if a value is present, otherwise false

    • isEmpty

      public boolean isEmpty()
      If a value is not present, returns true, otherwise false.
      Returns:
      true if a value is not present, otherwise false
      Since:
      11

    • ifPresent

      public Value1<C> ifPresent(io.vavr.CheckedConsumer<? super C> action)
      If a value is present, performs the given action with the value, otherwise does nothing.
      Parameters:
      action - the action to be performed, if a value is present
      Returns:
      this, for chaining
      Throws:
      NullPointerException - if value is present and the given action is null

    • ifPresentOrElse

      public Value1<C> ifPresentOrElse(io.vavr.CheckedConsumer<? super C> action, io.vavr.CheckedRunnable emptyAction)
      If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
      Parameters:
      action - the action to be performed, if a value is present
      emptyAction - the empty-based action to be performed, if no value is present
      Returns:
      this, for chaining
      Throws:
      NullPointerException - if a value is present and the given action is null, or no value is present and the given empty-based action is null.
      Since:
      9

    • ifEmpty

      public Value1<C> ifEmpty(io.vavr.CheckedRunnable emptyAction)
      Performs the empty-based action if no value is present, otherwise does nothing.
      Parameters:
      action - the action to be performed, if a value is present
      emptyAction - the empty-based action to be performed, if no value is present
      Returns:
      this, for chaining
      Throws:
      NullPointerException - if a value is present and the given action is null, or no value is present and the given empty-based action is null.
      Since:
      9

    • filter

      public Value1<C> filter(io.vavr.CheckedPredicate<? super C> predicate)
      If a value is present, and the value matches the given predicate, returns an Value1 describing the value, otherwise returns an empty Value1.
      Parameters:
      predicate - the predicate to apply to a value, if present
      Returns:
      an Value1 describing the value of this Value1, if a value is present and the value matches the given predicate, otherwise an empty Value1
      Throws:
      NullPointerException - if the predicate is null

    • map

      public <U> Value1<U> map(io.vavr.CheckedFunction1<? super C,? extends U> mapper)
      If a value is present, returns an Value1 describing (as if by #ofNullable) the result of applying the given mapping function to the value, otherwise returns an empty Value1.

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

      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 Value1 describing the result of applying a mapping function to the value of this Value1, if a value is present, otherwise an empty Value1
      Throws:
      NullPointerException - if the mapping function is null

    • flatMap

      public <U> Value1<U> flatMap(io.vavr.CheckedFunction1<? super C,? extends Optional<? extends U>> mapper)
      If a value is present, returns the result of applying the given Value1-bearing mapping function to the value, otherwise returns an empty Value1.

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

      Type Parameters:
      U - The type of value of the Value1 returned by the mapping function
      Parameters:
      mapper - the mapping function to apply to a value, if present
      Returns:
      the result of applying an Value1-bearing mapping function to the value of this Value1, if a value is present, otherwise an empty Value1
      Throws:
      NullPointerException - if the mapping function is null or returns a null result

    • or

      public Value1<C> or(io.vavr.CheckedFunction0<? extends Optional<? extends C>> supplier)
      If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
      Parameters:
      supplier - the supplying function that produces an Value1 to be returned
      Returns:
      returns an Value1 describing the value of this Value1, if a value is present, otherwise an Value1 produced by the supplying function.
      Throws:
      NullPointerException - if the supplying function is null or produces a null result
      Since:
      9

    • or

      public Value1<C> or(Optional<? extends C> useIfEmpty)
      If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
      Parameters:
      supplier - the supplying function that produces an Value1 to be returned
      Returns:
      returns an Value1 describing the value of this Value1, if a value is present, otherwise an Value1 produced by the supplying function.
      Throws:
      NullPointerException - if the supplying function is null or produces a null result
      Since:
      9

    • or

      public Value1<C> or(Value1<? extends C> useIfEmpty)
      If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
      Parameters:
      supplier - the supplying function that produces an Value1 to be returned
      Returns:
      returns an Value1 describing the value of this Value1, if a value is present, otherwise an Value1 produced by the supplying function.
      Throws:
      NullPointerException - if the supplying function is null or produces a null result
      Since:
      9

    • or

      public Value1<C> or(C useIfEmpty)
      If a value is present, returns an Value1 describing the value, otherwise returns an Value1 produced by the supplying function.
      Parameters:
      supplier - the supplying function that produces an Value1 to be returned
      Returns:
      returns an Value1 describing the value of this Value1, if a value is present, otherwise an Value1 produced by the supplying function.
      Throws:
      NullPointerException - if the supplying function is null or produces a null result
      Since:
      9

    • stream

      public Stream<C> stream()
      If a value is present, returns a sequential Stream containing only that value, otherwise returns an empty Stream.
      Returns:
      the optional value as a Stream
      Since:
      9

    • orElse

      @Nullable public C orElse(@Nullable C other)
      If a value is present, returns the value, otherwise returns other.
      Parameters:
      other - the value to be returned, if no value is present. May be null.
      Returns:
      the value, if present, otherwise other

    • orElseGet

      @Nullable public C orElseGet(Supplier<? extends C> supplier)
      If a value is present, returns the value, otherwise returns the result produced by the supplying function.
      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
      Throws:
      NullPointerException - if no value is present and the supplying function is null

    • orElseThrow

      public C orElseThrow()
      If a value is present, returns the value, otherwise throws NoSuchElementException.
      Returns:
      the non-null value described by this Value1
      Throws:
      NoSuchElementException - if no value is present
      Since:
      10

    • orElseThrow

      public <X extends Throwable> C orElseThrow(io.vavr.CheckedFunction0<? extends X> exceptionSupplier) throws X
      If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
      Type Parameters:
      X - Type of the exception to be thrown
      Parameters:
      exceptionSupplier - the supplying function that produces an exception to be thrown
      Returns:
      the value, if present
      Throws:
      X - if no value is present
      NullPointerException - if no value is present and the exception supplying function is null

    • toOptional

      public Optional<C> toOptional()
      Converts the last value to a Java Optional.

    • equals

      public boolean equals(@Nullable Object obj)
      Indicates whether some other object is "equal to" this Value1. The other object is considered equal if:
      • it is also an Value1 and;
      • both instances have no value present or;
      • the present values are "equal to" each other via equals().
      Overrides:
      equals in class Object
      Parameters:
      obj - an object to be tested for equality
      Returns:
      true if the other object is "equal to" this object otherwise false

    • hashCode

      public int hashCode()
      Returns the hash code of the value, if present, otherwise 0 (zero) if no value is present.
      Overrides:
      hashCode in class Object
      Returns:
      hash code value of the present value or 0 if no value is present

    • toString

      public String toString()
      Returns a non-empty string representation of this Value1 suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.
      Overrides:
      toString in class Object
      Returns:
      the string representation of this instance