com.mojang.datafixers.kinds

Class Const<C,T>

java.lang.Object

com.mojang.datafixers.kinds.Const<C,T>

Type Parameters:

C - The type of values stored in this class.

T - A phantom type representing the type of values the functor and applicative operations transform. No values of this type ever exist in objects of this type.

All Implemented Interfaces:

Const<C,T>

public final class Const<C,T>
extends Object

A Functor that stores values of an unrelated type. As functor and applicative operations are performed on const values, the stored values accumulate in a predictable fashion.

The type T is known as a phantom type. That is, no values of this type are ever required to use const objects. Because of this, the type T may be any type, even a type without any instances.

The Const type is typically used to supply values to traversal algorithms when the desired result does not depend on the types being traversed over.

See Also:

Monoid, Traversable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Const.Instance<C> The Applicative type class instance for Const.

Method Summary

Modifier and Type	Method and Description
static <C,T> Const<C,T>	create(C value) Creates a Const with the given stored value.
static <C,T> C	unbox(Const<C,T> box) Returns the value contained within the given const box.

Methods inherited from class java.lang.Object

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

Method Detail

unbox

public static <C,T> C unbox(Const<C,T> box)

Returns the value contained within the given const box.

Type Parameters:

C - The type of the stored value.

T - The type of value the boxed const purports to support.

Parameters:

box - The boxed Const.

Returns:

The stored value.

create

public static <C,T> Const<C,T> create(C value)

Creates a Const with the given stored value.

Type Parameters:

C - The type of the stored value.

T - The type of the value purportedly supported in the returned object.

Parameters:

value - The stored value.

Returns:

A Const that stores the given value.