com.mojang.datafixers.kinds

Class IdF<A>

java.lang.Object

com.mojang.datafixers.kinds.IdF<A>

Type Parameters:

A - The type of the contained value.

All Implemented Interfaces:

IdF<A>

public final class IdF<A>
extends Object

A container wrapping a single value.

The main feature of this class is its implementation of applicative functor operations. It's useful in cases where a functor is required but there is no existing functor that would be used.

API Note:

This class represents the identity functor, hence the name IdF.

See Also:

Identity monads, a similar concept for the monad type class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdF.Instance An instance of Functor and Applicative for IdF.

Field Summary

Fields

Modifier and Type	Field and Description
protected A	value The value contained in this IdF.

Method Summary

Modifier and Type	Method and Description
static <A> IdF<A>	create(A a) Creates an IdF container for a value.
static <A> A	get(IdF<A> box) Gets the value stored in an App representing an IdF instance.
A	value() Gets the value of this container.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected final A value

The value contained in this IdF.

Method Detail

value

public A value()

Gets the value of this container.

Returns:

The value.

get

public static <A> A get(IdF<A> box)

Gets the value stored in an App representing an IdF instance.

Type Parameters:

A - The type of the contained value.

Parameters:

box - The boxed IdF instance.

Throws:

ClassCastException - If the box is not an instance of IdF.

create

public static <A> IdF<A> create(A a)

Creates an IdF container for a value.

Type Parameters:

A - The type of the contained value.

Parameters:

a - The value that will be stored.

Returns:

The created container.