com.mojang.datafixers.kinds

Class Const.Instance<C>

java.lang.Object

com.mojang.datafixers.kinds.Const.Instance<C>

Type Parameters:

C - The type of value stored in the const objects.

All Implemented Interfaces:

instance Const<C,_>, Applicative Const<C,_>, Functor Const<C,_>, Kind1 Const<C,_>

Enclosing class:

Const<C,T>

public static final class Const.Instance<C>
extends Object
implements Applicative Const<C,_>

The Applicative type class instance for Const. Applicative operations on the type Const correspond to monoidal operations on the type C.

Type Shape:

instance %.Mu.[%0,_]

Constructor Summary

Constructors

Constructor and Description
Instance(Monoid<C> monoid) Constructs a new instance using the given Monoid type class instance.

Method Summary

Modifier and Type	Method and Description
<A,R> (Const<C,A>) -> Const<C,R>	lift1(Const<C,(A) -> R> function) Lifts a wrapped transformation function into a function between containers.
<A,B,R> (Const<C,A>,Const<C,B>) -> Const<C,R>	lift2(Const<C,(A,B) -> R> function) Lifts a wrapped BiFunction into a BiFunction between containers.
<T,R> Const<C,R>	map((? super T) -> ? extends R func, Const<C,T> ts) Maps the contents of ts from T to R using the func.
<A> Const<C,A>	point(A a) Wraps a value in a container, for example an object in a list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

ap, ap, ap10, ap11, ap12, ap13, ap14, ap15, ap16, ap2, ap3, ap4, ap5, ap6, ap7, ap8, ap9, apply2, apply3, apply4, apply5, apply6, apply7, apply8, apply9, lift3, lift4, lift5, lift6, lift7, lift8, lift9

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

Constructor Detail

Instance

public Instance(Monoid<C> monoid)

Constructs a new instance using the given Monoid type class instance.

Parameters:

monoid - The monoid instance that defines the behavior of the type C.

Method Detail

map

public <T,R> Const<C,R> map((? super T) -> ? extends R func,
                            Const<C,T> ts)

Maps the contents of ts from T to R using the func.

This method simply leaves the stored value unchanged.

Specified by:

map in interface Functor Const<C,_>

Type Parameters:

T - The input type.

R - The output type.

Parameters:

func - The transformation function.

ts - The input container that will be transformed.

Returns:

The transformed container.

point

public <A> Const<C,A> point(A a)

Wraps a value in a container, for example an object in a list.

This method corresponds to Monoid.point().

Specified by:

point in interface Applicative Const<C,_>

Type Parameters:

A - The type of the value.

Parameters:

a - The input value.

Returns:

The wrapper containing the value.

lift1

public <A,R> (Const<C,A>) -> Const<C,R> lift1(Const<C,(A) -> R> function)

Lifts a wrapped transformation function into a function between containers.

This method corresponds to Monoid.add(Object, Object).

Specified by:

lift1 in interface Applicative Const<C,_>

Type Parameters:

A - The input type.

R - The output type.

Parameters:

function - The container containing the transformation function.

Returns:

The lifted function.

lift2

public <A,B,R> (Const<C,A>,Const<C,B>) -> Const<C,R> lift2(Const<C,(A,B) -> R> function)

Description copied from interface: Applicative

Lifts a wrapped BiFunction into a BiFunction between containers.

Specified by:

lift2 in interface Applicative Const<C,_>

Type Parameters:

A - The first input type.

B - The second input type.

R - The output type.

Parameters:

function - The container containing the transformation function.

Returns:

The lifted function.