Package com.jnape.palatable.lambda.adt
Class These<A,B>
- java.lang.Object
-
- com.jnape.palatable.lambda.adt.These<A,B>
-
- Type Parameters:
A
- the first possible typeB
- the second possible type
- All Implemented Interfaces:
CoProduct3<A,B,Tuple2<A,B>,These<A,B>>
,Applicative<B,These<A,?>>
,Bifunctor<A,B,These<?,?>>
,BoundedBifunctor<A,B,java.lang.Object,java.lang.Object,These<?,?>>
,Functor<B,These<A,?>>
,Monad<B,These<A,?>>
,MonadRec<B,These<A,?>>
,Traversable<B,These<A,?>>
- Direct Known Subclasses:
These._A
,These._B
,These.Both
public abstract class These<A,B> extends java.lang.Object implements CoProduct3<A,B,Tuple2<A,B>,These<A,B>>, MonadRec<B,These<A,?>>, Bifunctor<A,B,These<?,?>>, Traversable<B,These<A,?>>
The coproduct of a coproduct (
) and its product (CoProduct2
<A, B>
), represented as aTuple2
<A, B>
.CoProduct3
<A, B,Tuple2
<A, B>>
-
-
Constructor Summary
Constructors Modifier Constructor Description private
These()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static <A,B>
These<A,B>a(A a)
Static factory method for wrapping a value of typeA
in aThese
.static <A,B>
These<A,B>b(B b)
Static factory method for wrapping a value of typeB
in aThese
.<C,D>
These<C,D>biMap(Fn1<? super A,? extends C> lFn, Fn1<? super B,? extends D> rFn)
Dually map covariantly over both the left and right parameters.<Z> These<Z,B>
biMapL(Fn1<? super A,? extends Z> fn)
Covariantly map over the left parameter.<C> These<A,C>
biMapR(Fn1<? super B,? extends C> fn)
Covariantly map over the right parameter.static <A,B>
These<A,B>both(A a, B b)
<C> These<A,C>
discardL(Applicative<C,These<A,?>> appB)
Sequence both thisApplicative
andappB
, discarding thisApplicative's
result and returningappB
.<C> These<A,B>
discardR(Applicative<C,These<A,?>> appB)
Sequence both thisApplicative
andappB
, discardingappB's
result and returning thisApplicative
.<C> These<A,C>
flatMap(Fn1<? super B,? extends Monad<C,These<A,?>>> f)
Chain dependent computations that may continue or short-circuit based on previous results.<C> These<A,C>
fmap(Fn1<? super B,? extends C> fn)
Covariantly transmute this functor's parameter using the given mapping function.static <A,B>
Maybe<These<A,B>>fromMaybes(Maybe<A> maybeA, Maybe<B> maybeB)
<C> Lazy<These<A,C>>
lazyZip(Lazy<? extends Applicative<Fn1<? super B,? extends C>,These<A,?>>> lazyAppFn)
Given alazy
instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.<C> These<A,C>
pure(C c)
Lift the valueb
into this applicative functor.static <A> Pure<These<A,?>>
pureThese()
<C> These<A,C>
trampolineM(Fn1<? super B,? extends MonadRec<RecursiveResult<B,C>,These<A,?>>> fn)
Given some operation yielding aRecursiveResult
inside thisMonadRec
, internally trampoline the operation until it yields atermination
instruction.<C,App extends Applicative<?,App>,TravC extends Traversable<C,These<A,?>>,AppTrav extends Applicative<TravC,App>>
AppTravtraverse(Fn1<? super B,? extends Applicative<C,App>> fn, Fn1<? super TravC,? extends AppTrav> pure)
Applyfn
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.<C> These<A,C>
zip(Applicative<Fn1<? super B,? extends C>,These<A,?>> appFn)
Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Method Detail
-
biMap
public final <C,D> These<C,D> biMap(Fn1<? super A,? extends C> lFn, Fn1<? super B,? extends D> rFn)
Dually map covariantly over both the left and right parameters. This is isomorphic tobiMapL(lFn).biMapR(rFn)
.- Specified by:
biMap
in interfaceBifunctor<A,B,These<?,?>>
- Specified by:
biMap
in interfaceBoundedBifunctor<A,B,java.lang.Object,java.lang.Object,These<?,?>>
- Type Parameters:
C
- the new left parameter typeD
- the new right parameter type- Parameters:
lFn
- the left parameter mapping functionrFn
- the right parameter mapping function- Returns:
- a bifunctor over C (the new left parameter type) and D (the new right parameter type)
-
flatMap
public final <C> These<A,C> flatMap(Fn1<? super B,? extends Monad<C,These<A,?>>> f)
Chain dependent computations that may continue or short-circuit based on previous results.
-
trampolineM
public <C> These<A,C> trampolineM(Fn1<? super B,? extends MonadRec<RecursiveResult<B,C>,These<A,?>>> fn)
Given some operation yielding aRecursiveResult
inside thisMonadRec
, internally trampoline the operation until it yields atermination
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 interfaceMonadRec<A,B>
- Type Parameters:
C
- the ultimate resulting carrier type- Parameters:
fn
- the function to internally trampoline- Returns:
- the trampolined
MonadRec
- See Also:
for a basic implementation
,for a implementation
,for an implementation leveraging an already stack-safe
,for a implementation
-
traverse
public <C,App extends Applicative<?,App>,TravC extends Traversable<C,These<A,?>>,AppTrav extends Applicative<TravC,App>> AppTrav traverse(Fn1<? super B,? extends Applicative<C,App>> fn, Fn1<? super TravC,? extends AppTrav> pure)
Applyfn
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 interfaceTraversable<A,B>
- Type Parameters:
C
- the resulting element typeApp
- the result applicative typeTravC
- this Traversable instance over BAppTrav
- the full inferred resulting type from the traversal- Parameters:
fn
- the function to applypure
- the applicative pure function- Returns:
- the traversed Traversable, wrapped inside an applicative
-
biMapL
public final <Z> These<Z,B> biMapL(Fn1<? super A,? extends Z> fn)
Covariantly map over the left parameter.- Specified by:
biMapL
in interfaceBifunctor<A,B,These<?,?>>
- Specified by:
biMapL
in interfaceBoundedBifunctor<A,B,java.lang.Object,java.lang.Object,These<?,?>>
- Type Parameters:
Z
- 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 final <C> These<A,C> biMapR(Fn1<? super B,? extends C> fn)
Covariantly map over the right parameter. For all bifunctors that are also functors, it should hold thatbiMapR(f) == fmap(f)
.- Specified by:
biMapR
in interfaceBifunctor<A,B,These<?,?>>
- Specified by:
biMapR
in interfaceBoundedBifunctor<A,B,java.lang.Object,java.lang.Object,These<?,?>>
- Type Parameters:
C
- 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)
-
fmap
public final <C> These<A,C> fmap(Fn1<? super B,? extends C> 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 interfaceApplicative<A,B>
- Specified by:
fmap
in interfaceFunctor<A,B>
- Specified by:
fmap
in interfaceMonad<A,B>
- Specified by:
fmap
in interfaceMonadRec<A,B>
- Specified by:
fmap
in interfaceTraversable<A,B>
- Type Parameters:
C
- the new parameter type- Parameters:
fn
- the mapping function- Returns:
- a functor over B (the new parameter type)
-
zip
public final <C> These<A,C> zip(Applicative<Fn1<? super B,? extends C>,These<A,?>> appFn)
Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.
-
lazyZip
public <C> Lazy<These<A,C>> lazyZip(Lazy<? extends Applicative<Fn1<? super B,? extends C>,These<A,?>>> lazyAppFn)
Given alazy
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 interfaceApplicative<A,B>
- Specified by:
lazyZip
in interfaceMonad<A,B>
- Specified by:
lazyZip
in interfaceMonadRec<A,B>
- Type Parameters:
C
- the resulting applicative parameter type- Parameters:
lazyAppFn
- the lazy other applicative instance- Returns:
- the mapped applicative
- See Also:
Maybe
,Either
-
discardL
public final <C> These<A,C> discardL(Applicative<C,These<A,?>> appB)
Sequence both thisApplicative
andappB
, discarding thisApplicative's
result and returningappB
. This is generally useful for sequentially performing side-effects.
-
discardR
public final <C> These<A,B> discardR(Applicative<C,These<A,?>> appB)
Sequence both thisApplicative
andappB
, discardingappB's
result and returning thisApplicative
. This is generally useful for sequentially performing side-effects.
-
a
public static <A,B> These<A,B> a(A a)
Static factory method for wrapping a value of typeA
in aThese
.- Type Parameters:
A
- the first possible typeB
- the second possible type- Parameters:
a
- the value- Returns:
- the wrapped value as a
These
<A,B>
-
b
public static <A,B> These<A,B> b(B b)
Static factory method for wrapping a value of typeB
in aThese
.- Type Parameters:
A
- the first possible typeB
- the second possible type- Parameters:
b
- the value- Returns:
- the wrapped value as a
These
<A,B>
-
both
public static <A,B> These<A,B> both(A a, B b)
- Type Parameters:
A
- the first possible typeB
- the second possible type- Parameters:
a
- the first valueb
- the second value- Returns:
- the wrapped values as a
These
<A,B>
-
fromMaybes
public static <A,B> Maybe<These<A,B>> fromMaybes(Maybe<A> maybeA, Maybe<B> maybeB)
Convenience method for converting a pair ofMaybe
s into aMaybe
ofThese
. If bothMaybe
s areMaybe.just(A)
then the result is aMaybe.just(A)
both(A, B)
. If only oneMaybe
isMaybe.just(A)
then it will beMaybe.just(A)
a(A)
orMaybe.just(A)
b(B)
. If bothMaybe
s areMaybe.nothing()
then the result will beMaybe.nothing()
.
-
-