Module net.luis.utils
Package net.luis.utils.util

Class Either.Left<L,R>

java.lang.Object
net.luis.utils.util.Either<L,R>
net.luis.utils.util.Either.Left<L,R>
Type Parameters:
L - The type of the left value
R - The type of the right value
Enclosing class:
Either<L,R>
static final class Either.Left<L,R> extends Either<L,R>
Left implementation of the either.

  • Nested Class Summary

    Nested classes/interfaces inherited from class net.luis.utils.util.Either

    Either.Left<L,R>, Either.Right<L,R>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final L
    value
    The value of the left either.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Left(L value)
    Constructs a new left either instance with the given value.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    hashCode()
     
    void
    ifLeft(@NotNull Consumer<? super L> action)
    Performs the given action if this either instance is a left instance.
    void
    ifRight(@Nullable Consumer<? super R> action)
    Performs the given action if this either instance is a right instance.
    boolean
    isLeft()
    Checks if this either instance is a left instance.
    boolean
    isRight()
    Checks if this either instance is a right instance.
    @NotNull Optional<L>
    left()
    Returns the left value as an Optional.
    @UnknownNullability L
    leftOrThrow()
    Returns the left value or throws an exception if it is a right either.
    <C, D> @NotNull Either<C,D>
    mapBoth(@NotNull Function<? super L,? extends C> leftMapper, @NotNull Function<? super R,? extends D> rightMapper)
    Maps the left and right values of this either instance to new values.
    <T> T
    mapTo(@NotNull Function<? super L,? extends T> leftMapper, @NotNull Function<? super R,? extends T> rightMapper)
    Maps the left and right values of this either instance to a new value.
    @NotNull Optional<R>
    right()
    Returns the right value as an Optional.
    R
    rightOrThrow()
    Returns the right value or throws an exception if it is a left either.
    String
    toString()
     

    Methods inherited from class net.luis.utils.util.Either

    left, mapLeft, mapRight, right, swap

    Methods inherited from class java.lang.Object

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

  • Field Details

    • value

      private final L value
      The value of the left either.

  • Constructor Details

    • Left

      private Left(@Nullable L value)
      Constructs a new left either instance with the given value.
      Parameters:
      value - The value of the left either

  • Method Details

    • isLeft

      public boolean isLeft()
      Description copied from class: Either
      Checks if this either instance is a left instance.
      Specified by:
      isLeft in class Either<L,R>
      Returns:
      True if this either instance is a left instance, false otherwise

    • isRight

      public boolean isRight()
      Description copied from class: Either
      Checks if this either instance is a right instance.
      Specified by:
      isRight in class Either<L,R>
      Returns:
      True if this either instance is a right instance, false otherwise

    • ifLeft

      public void ifLeft(@NotNull @NotNull Consumer<? super L> action)
      Description copied from class: Either
      Performs the given action if this either instance is a left instance.
      Specified by:
      ifLeft in class Either<L,R>
      Parameters:
      action - The action to perform

    • ifRight

      public void ifRight(@Nullable @Nullable Consumer<? super R> action)
      Description copied from class: Either
      Performs the given action if this either instance is a right instance.
      Specified by:
      ifRight in class Either<L,R>
      Parameters:
      action - The action to perform

    • left

      @NotNull public @NotNull Optional<L> left()
      Description copied from class: Either
      Returns the left value as an Optional.
      Specified by:
      left in class Either<L,R>
      Returns:
      The left value

    • right

      @NotNull public @NotNull Optional<R> right()
      Description copied from class: Either
      Returns the right value as an Optional.
      Specified by:
      right in class Either<L,R>
      Returns:
      The right value

    • leftOrThrow

      public @UnknownNullability L leftOrThrow()
      Description copied from class: Either
      Returns the left value or throws an exception if it is a right either.
      Specified by:
      leftOrThrow in class Either<L,R>
      Returns:
      The left value

    • rightOrThrow

      @NotNull public R rightOrThrow()
      Description copied from class: Either
      Returns the right value or throws an exception if it is a left either.
      Specified by:
      rightOrThrow in class Either<L,R>
      Returns:
      The right value

    • mapBoth

      @NotNull public <C, D> @NotNull Either<C,D> mapBoth(@NotNull @NotNull Function<? super L,? extends C> leftMapper, @NotNull @NotNull Function<? super R,? extends D> rightMapper)
      Description copied from class: Either
      Maps the left and right values of this either instance to new values.
      Specified by:
      mapBoth in class Either<L,R>
      Type Parameters:
      C - The new type of the left value
      D - The new type of the right value
      Parameters:
      leftMapper - The mapper for the left value
      rightMapper - The mapper for the right value
      Returns:
      A new either instance with the mapped values

    • mapTo

      public <T> T mapTo(@NotNull @NotNull Function<? super L,? extends T> leftMapper, @NotNull @NotNull Function<? super R,? extends T> rightMapper)
      Description copied from class: Either
      Maps the left and right values of this either instance to a new value.
      Specified by:
      mapTo in class Either<L,R>
      Type Parameters:
      T - The type of the mapped value
      Parameters:
      leftMapper - The mapper for the left value
      rightMapper - The mapper for the right value
      Returns:
      The mapped value

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object