Class Identity<A>
- java.lang.Object
-
- com.jnape.palatable.lambda.functor.builtin.Identity<A>
-
- Type Parameters:
A
- the value type
- All Implemented Interfaces:
Applicative<A,Identity<?>>
,Functor<A,Identity<?>>
,Monad<A,Identity<?>>
,MonadRec<A,Identity<?>>
,Traversable<A,Identity<?>>
public final class Identity<A> extends java.lang.Object implements MonadRec<A,Identity<?>>, Traversable<A,Identity<?>>
A functor over some value of typeA
that can be mapped over and retrieved later.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <B> Identity<B>
discardL(Applicative<B,Identity<?>> appB)
Sequence both thisApplicative
andappB
, discarding thisApplicative's
result and returningappB
.<B> Identity<A>
discardR(Applicative<B,Identity<?>> appB)
Sequence both thisApplicative
andappB
, discardingappB's
result and returning thisApplicative
.boolean
equals(java.lang.Object other)
<B> Identity<B>
flatMap(Fn1<? super A,? extends Monad<B,Identity<?>>> f)
Chain dependent computations that may continue or short-circuit based on previous results.<B> Identity<B>
fmap(Fn1<? super A,? extends B> fn)
Covariantly transmute this functor's parameter using the given mapping function.int
hashCode()
<B> Lazy<Identity<B>>
lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,Identity<?>>> lazyAppFn)
Given alazy
instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.<B> Identity<B>
pure(B b)
Lift the valueb
into this applicative functor.static Pure<Identity<?>>
pureIdentity()
A
runIdentity()
Retrieve the value.java.lang.String
toString()
<B> Identity<B>
trampolineM(Fn1<? super A,? extends MonadRec<RecursiveResult<A,B>,Identity<?>>> fn)
Given some operation yielding aRecursiveResult
inside thisMonadRec
, internally trampoline the operation until it yields atermination
instruction.<B,App extends Applicative<?,App>,TravB extends Traversable<B,Identity<?>>,AppTrav extends Applicative<TravB,App>>
AppTravtraverse(Fn1<? super A,? extends Applicative<B,App>> fn, Fn1<? super TravB,? 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.<B> Identity<B>
zip(Applicative<Fn1<? super A,? extends B>,Identity<?>> appFn)
Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.
-
-
-
Field Detail
-
a
private final A a
-
-
Constructor Detail
-
Identity
public Identity(A a)
-
-
Method Detail
-
runIdentity
public A runIdentity()
Retrieve the value.- Returns:
- the value
-
flatMap
public <B> Identity<B> flatMap(Fn1<? super A,? extends Monad<B,Identity<?>>> f)
Chain dependent computations that may continue or short-circuit based on previous results.
-
fmap
public <B> Identity<B> fmap(Fn1<? super A,? extends B> 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,Identity<?>>
- Specified by:
fmap
in interfaceFunctor<A,Identity<?>>
- Specified by:
fmap
in interfaceMonad<A,Identity<?>>
- Specified by:
fmap
in interfaceMonadRec<A,Identity<?>>
- Specified by:
fmap
in interfaceTraversable<A,Identity<?>>
- Type Parameters:
B
- the new parameter type- Parameters:
fn
- the mapping function- Returns:
- a functor over B (the new parameter type)
-
pure
public <B> Identity<B> pure(B b)
Lift the valueb
into this applicative functor.- Specified by:
pure
in interfaceApplicative<A,Identity<?>>
- Specified by:
pure
in interfaceMonad<A,Identity<?>>
- Specified by:
pure
in interfaceMonadRec<A,Identity<?>>
- Type Parameters:
B
- the type of the returned applicative's parameter- Parameters:
b
- the value- Returns:
- an instance of this applicative over b
-
zip
public <B> Identity<B> zip(Applicative<Fn1<? super A,? extends B>,Identity<?>> 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 interfaceApplicative<A,Identity<?>>
- Specified by:
zip
in interfaceMonad<A,Identity<?>>
- Specified by:
zip
in interfaceMonadRec<A,Identity<?>>
- Type Parameters:
B
- the resulting applicative parameter type- Parameters:
appFn
- the other applicative instance- Returns:
- the mapped applicative
-
lazyZip
public <B> Lazy<Identity<B>> lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,Identity<?>>> 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,Identity<?>>
- Specified by:
lazyZip
in interfaceMonad<A,Identity<?>>
- Specified by:
lazyZip
in interfaceMonadRec<A,Identity<?>>
- Type Parameters:
B
- the resulting applicative parameter type- Parameters:
lazyAppFn
- the lazy other applicative instance- Returns:
- the mapped applicative
- See Also:
Maybe
,Either
-
discardL
public <B> Identity<B> discardL(Applicative<B,Identity<?>> appB)
Sequence both thisApplicative
andappB
, discarding thisApplicative's
result and returningappB
. This is generally useful for sequentially performing side-effects.- Specified by:
discardL
in interfaceApplicative<A,Identity<?>>
- Specified by:
discardL
in interfaceMonad<A,Identity<?>>
- Specified by:
discardL
in interfaceMonadRec<A,Identity<?>>
- Type Parameters:
B
- the type of the returned Applicative's parameter- Parameters:
appB
- the other Applicative- Returns:
- appB
-
discardR
public <B> Identity<A> discardR(Applicative<B,Identity<?>> appB)
Sequence both thisApplicative
andappB
, discardingappB's
result and returning thisApplicative
. This is generally useful for sequentially performing side-effects.
-
traverse
public <B,App extends Applicative<?,App>,TravB extends Traversable<B,Identity<?>>,AppTrav extends Applicative<TravB,App>> AppTrav traverse(Fn1<? super A,? extends Applicative<B,App>> fn, Fn1<? super TravB,? 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,Identity<?>>
- Type Parameters:
B
- the resulting element typeApp
- the result applicative typeTravB
- 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
-
trampolineM
public <B> Identity<B> trampolineM(Fn1<? super A,? extends MonadRec<RecursiveResult<A,B>,Identity<?>>> 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,Identity<?>>
- Type Parameters:
B
- 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
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-