Class Choice5<A,B,C,D,E>

java.lang.Object
com.jnape.palatable.lambda.adt.choice.Choice5<A,B,C,D,E>
Type Parameters:
A - the first possible type
B - the second possible type
C - the third possible type
D - the fourth possible type
E - the fifth possible type
All Implemented Interfaces:
CoProduct5<A,B,C,D,E,Choice5<A,B,C,D,E>>, Applicative<E,Choice5<A,B,C,D,?>>, Bifunctor<D,E,Choice5<A,B,C,?,?>>, BoundedBifunctor<D,E,Object,Object,Choice5<A,B,C,?,?>>, Functor<E,Choice5<A,B,C,D,?>>, Monad<E,Choice5<A,B,C,D,?>>, MonadRec<E,Choice5<A,B,C,D,?>>, Traversable<E,Choice5<A,B,C,D,?>>
Direct Known Subclasses:
Choice5._A, Choice5._B, Choice5._C, Choice5._D, Choice5._E

public abstract class Choice5<A,B,C,D,E> extends Object implements CoProduct5<A,B,C,D,E,Choice5<A,B,C,D,E>>, MonadRec<E,Choice5<A,B,C,D,?>>, Bifunctor<D,E,Choice5<A,B,C,?,?>>, Traversable<E,Choice5<A,B,C,D,?>>
Canonical ADT representation of CoProduct5.
See Also:
  • Constructor Details

    • Choice5

      private Choice5()
  • Method Details

    • project

      public Tuple5<Maybe<A>,Maybe<B>,Maybe<C>,Maybe<D>,Maybe<E>> project()
      Specialize this choice's projection to a Tuple5.
      Specified by:
      project in interface CoProduct5<A,B,C,D,E,Choice5<A,B,C,D,E>>
      Returns:
      a Tuple5
      See Also:
    • diverge

      public <F> Choice6<A,B,C,D,E,F> diverge()
      Diverge this coproduct by introducing another possible type that it could represent.
      Specified by:
      diverge in interface CoProduct5<A,B,C,D,E,Choice5<A,B,C,D,E>>
      Type Parameters:
      F - the additional possible type of this coproduct
      Returns:
      a Coproduct6<A, B, C, D, E, F>
      See Also:
    • converge

      public Choice4<A,B,C,D> converge(Fn1<? super E,? extends CoProduct4<A,B,C,D,?>> convergenceFn)
      Converge this coproduct down to a lower order coproduct by mapping the last possible type into an earlier possible type.
      Specified by:
      converge in interface CoProduct5<A,B,C,D,E,Choice5<A,B,C,D,E>>
      Parameters:
      convergenceFn - morphism E -> CoProduct4<A, B, C, D>
      Returns:
      a CoProduct4<A, B, C, D>
    • fmap

      public <F> Choice5<A,B,C,D,F> fmap(Fn1<? super E,? extends F> fn)
      Covariantly transmute this functor's parameter using the given mapping function. Generally this method is specialized to return an instance of the class implementing Functor.
      Specified by:
      fmap in interface Applicative<A,B>
      Specified by:
      fmap in interface Functor<A,B>
      Specified by:
      fmap in interface Monad<A,B>
      Specified by:
      fmap in interface MonadRec<A,B>
      Specified by:
      fmap in interface Traversable<A,B>
      Type Parameters:
      F - the new parameter type
      Parameters:
      fn - the mapping function
      Returns:
      a functor over B (the new parameter type)
    • biMapL

      public <F> Choice5<A,B,C,F,E> biMapL(Fn1<? super D,? extends F> fn)
      Covariantly map over the left parameter.
      Specified by:
      biMapL in interface Bifunctor<A,B,C>
      Specified by:
      biMapL in interface BoundedBifunctor<A,B,C,D,E>
      Type Parameters:
      F - the new left parameter type
      Parameters:
      fn - the mapping function
      Returns:
      a bifunctor over C (the new left parameter) and B (the same right parameter)
    • biMapR

      public <F> Choice5<A,B,C,D,F> biMapR(Fn1<? super E,? extends F> fn)
      Covariantly map over the right parameter. For all bifunctors that are also functors, it should hold that biMapR(f) == fmap(f).
      Specified by:
      biMapR in interface Bifunctor<A,B,C>
      Specified by:
      biMapR in interface BoundedBifunctor<A,B,C,D,E>
      Type Parameters:
      F - the new right parameter type
      Parameters:
      fn - the mapping function
      Returns:
      a bifunctor over A (the same left parameter) and C (the new right parameter)
    • biMap

      public <F, G> Choice5<A,B,C,F,G> biMap(Fn1<? super D,? extends F> lFn, Fn1<? super E,? extends G> rFn)
      Dually map covariantly over both the left and right parameters. This is isomorphic to biMapL(lFn).biMapR(rFn).
      Specified by:
      biMap in interface Bifunctor<A,B,C>
      Specified by:
      biMap in interface BoundedBifunctor<A,B,C,D,E>
      Type Parameters:
      F - the new left parameter type
      G - the new right parameter type
      Parameters:
      lFn - the left parameter mapping function
      rFn - the right parameter mapping function
      Returns:
      a bifunctor over C (the new left parameter type) and D (the new right parameter type)
    • pure

      public <F> Choice5<A,B,C,D,F> pure(F f)
      Lift the value b into this applicative functor.
      Specified by:
      pure in interface Applicative<A,B>
      Specified by:
      pure in interface Monad<A,B>
      Specified by:
      pure in interface MonadRec<A,B>
      Type Parameters:
      F - the type of the returned applicative's parameter
      Parameters:
      f - the value
      Returns:
      an instance of this applicative over b
    • zip

      public <F> Choice5<A,B,C,D,F> zip(Applicative<Fn1<? super E,? extends F>,Choice5<A,B,C,D,?>> appFn)
      Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.
      Specified by:
      zip in interface Applicative<A,B>
      Specified by:
      zip in interface Monad<A,B>
      Specified by:
      zip in interface MonadRec<A,B>
      Type Parameters:
      F - the resulting applicative parameter type
      Parameters:
      appFn - the other applicative instance
      Returns:
      the mapped applicative
    • lazyZip

      public <F> Lazy<Choice5<A,B,C,D,F>> lazyZip(Lazy<? extends Applicative<Fn1<? super E,? extends F>,Choice5<A,B,C,D,?>>> lazyAppFn)
      Given a lazy instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports. This is useful for applicatives that support lazy evaluation and early termination.
      Specified by:
      lazyZip in interface Applicative<A,B>
      Specified by:
      lazyZip in interface Monad<A,B>
      Specified by:
      lazyZip in interface MonadRec<A,B>
      Type Parameters:
      F - the resulting applicative parameter type
      Parameters:
      lazyAppFn - the lazy other applicative instance
      Returns:
      the mapped applicative
      See Also:
    • discardL

      public <F> Choice5<A,B,C,D,F> discardL(Applicative<F,Choice5<A,B,C,D,?>> appB)
      Sequence both this Applicative and appB, discarding this Applicative's result and returning appB. This is generally useful for sequentially performing side-effects.
      Specified by:
      discardL in interface Applicative<A,B>
      Specified by:
      discardL in interface Monad<A,B>
      Specified by:
      discardL in interface MonadRec<A,B>
      Type Parameters:
      F - the type of the returned Applicative's parameter
      Parameters:
      appB - the other Applicative
      Returns:
      appB
    • discardR

      public <F> Choice5<A,B,C,D,E> discardR(Applicative<F,Choice5<A,B,C,D,?>> appB)
      Sequence both this Applicative and appB, discarding appB's result and returning this Applicative. This is generally useful for sequentially performing side-effects.
      Specified by:
      discardR in interface Applicative<A,B>
      Specified by:
      discardR in interface Monad<A,B>
      Specified by:
      discardR in interface MonadRec<A,B>
      Type Parameters:
      F - the type of appB's parameter
      Parameters:
      appB - the other Applicative
      Returns:
      this Applicative
    • flatMap

      public <F> Choice5<A,B,C,D,F> flatMap(Fn1<? super E,? extends Monad<F,Choice5<A,B,C,D,?>>> f)
      Chain dependent computations that may continue or short-circuit based on previous results.
      Specified by:
      flatMap in interface Monad<A,B>
      Specified by:
      flatMap in interface MonadRec<A,B>
      Type Parameters:
      F - the resulting monad parameter type
      Parameters:
      f - the dependent computation over A
      Returns:
      the new monad instance
    • trampolineM

      public <F> Choice5<A,B,C,D,F> trampolineM(Fn1<? super E,? extends MonadRec<RecursiveResult<E,F>,Choice5<A,B,C,D,?>>> fn)
      Given some operation yielding a RecursiveResult inside this MonadRec, internally trampoline the operation until it yields a termination instruction.

      Stack-safety depends on implementations guaranteeing that the growth of the call stack is a constant factor independent of the number of invocations of the operation. For various examples of how this can be achieved in stereotypical circumstances, see the referenced types.

      Specified by:
      trampolineM in interface MonadRec<A,B>
      Type Parameters:
      F - the ultimate resulting carrier type
      Parameters:
      fn - the function to internally trampoline
      Returns:
      the trampolined MonadRec
      See Also:
    • traverse

      public <F, App extends Applicative<?, App>, TravB extends Traversable<F, Choice5<A, B, C, D, ?>>, AppTrav extends Applicative<TravB, App>> AppTrav traverse(Fn1<? super E,? extends Applicative<F,App>> fn, Fn1<? super TravB,? extends AppTrav> pure)
      Apply fn to each element of this traversable from left to right, and collapse the results into a single resulting applicative, potentially with the assistance of the applicative's pure function.
      Specified by:
      traverse in interface Traversable<A,B>
      Type Parameters:
      F - the resulting element type
      App - the result applicative type
      TravB - this Traversable instance over B
      AppTrav - the full inferred resulting type from the traversal
      Parameters:
      fn - the function to apply
      pure - the applicative pure function
      Returns:
      the traversed Traversable, wrapped inside an applicative
    • a

      public static <A, B, C, D, E> Choice5<A,B,C,D,E> a(A a)
      Static factory method for wrapping a value of type A in a Choice5.
      Type Parameters:
      A - the first possible type
      B - the second possible type
      C - the third possible type
      D - the fourth possible type
      E - the fifth possible type
      Parameters:
      a - the value
      Returns:
      the wrapped value as a Choice5<A, B, C, D, E>
    • b

      public static <A, B, C, D, E> Choice5<A,B,C,D,E> b(B b)
      Static factory method for wrapping a value of type B in a Choice5.
      Type Parameters:
      A - the first possible type
      B - the second possible type
      C - the third possible type
      D - the fourth possible type
      E - the fifth possible type
      Parameters:
      b - the value
      Returns:
      the wrapped value as a Choice5<A, B, C, D, E>
    • c

      public static <A, B, C, D, E> Choice5<A,B,C,D,E> c(C c)
      Static factory method for wrapping a value of type C in a Choice5.
      Type Parameters:
      A - the first possible type
      B - the second possible type
      C - the third possible type
      D - the fourth possible type
      E - the fifth possible type
      Parameters:
      c - the value
      Returns:
      the wrapped value as a Choice5<A, B, C, D, E>
    • d

      public static <A, B, C, D, E> Choice5<A,B,C,D,E> d(D d)
      Static factory method for wrapping a value of type D in a Choice5.
      Type Parameters:
      A - the first possible type
      B - the second possible type
      C - the third possible type
      D - the fourth possible type
      E - the fifth possible type
      Parameters:
      d - the value
      Returns:
      the wrapped value as a Choice5<A, B, C, D, E>
    • e

      public static <A, B, C, D, E> Choice5<A,B,C,D,E> e(E e)
      Static factory method for wrapping a value of type E in a Choice5.
      Type Parameters:
      A - the first possible type
      B - the second possible type
      C - the third possible type
      D - the fourth possible type
      E - the fifth possible type
      Parameters:
      e - the value
      Returns:
      the wrapped value as a Choice5<A, B, C, D, E>
    • pureChoice

      public static <A, B, C, D> Pure<Choice5<A,B,C,D,?>> pureChoice()
      The canonical Pure instance for Choice5.
      Type Parameters:
      A - the first possible type
      B - the second possible type
      C - the third possible type
      D - the fourth possible type
      Returns:
      the Pure instance