com.mojang.datafixers.kinds

Interface CocartesianLike<T extends K1,C,Mu extends CocartesianLike _>

Type Parameters:

T - The container type.

C - The right type of the either.

Mu - The witness type for this functor.

All Superinterfaces:

Mu<T>, Functor T, Kind1 T, Traversable T

All Known Implementing Classes:

Either.Instance

public interface CocartesianLike<T extends K1,C,Mu extends CocartesianLike _>
extends Functor T, Traversable T

A Traversable functor that can convert values to and from a sum type. This type class defines two methods, from(App) and to(App), that convert the type T from and to the type Either.

Type Shape:

%.Type. %0

See Also:

Cocartesian

Method Summary

Modifier and Type	Method and Description
<A> T<A>	from((A|C) input) Converts the given Either to the container type.
<A> (A|C)	to(T<A> input) Converts the given container to an Either.
default <F extends K1,A,B> F<T<B>>	traverse(Applicative F applicative, (A) -> F<B> function, T<A> input) Applies a function that produces an Applicative effect to each value contained within input, then builds a container with an equivalent structure containing the (unboxed) results.

Methods inherited from interface com.mojang.datafixers.kinds.Traversable

flip

Methods inherited from interface com.mojang.datafixers.kinds.Functor

map

Methods inherited from interface com.mojang.datafixers.kinds.Kind1

group, group, group, group, group, group, group, group, group, group, group, group, group, group, group, group

Method Detail

to

<A> (A|C) to(T<A> input)

Converts the given container to an Either.

Type Parameters:

A - The type of the contained values.

Parameters:

input - The container.

Returns:

An Either representing an equivalent container.

from

<A> T<A> from((A|C) input)

Converts the given Either to the container type.

Type Parameters:

A - The type of the contained values.

Parameters:

input - The Either.

Returns:

A container equivalent to the input.

traverse

default <F extends K1,A,B> F<T<B>> traverse(Applicative F applicative,
                                            (A) -> F<B> function,
                                            T<A> input)

Description copied from interface: Traversable

Applies a function that produces an Applicative effect to each value contained within input, then builds a container with an equivalent structure containing the (unboxed) results.

Specified by:

traverse in interface Traversable T extends K1

Type Parameters:

F - The type of the effect.

A - The input type.

B - The output type.

Parameters:

applicative - An instance of the Applicative type class which defines the behavior of F.

function - The function to apply.

input - The input container.

Returns:

A container holding the results of applying function to each element, if the function was successful for every element.