com.mojang.datafixers.optics

Class Optic.CompositionOptic<Proof extends K1,S,T,A,B,A1,B1>

java.lang.Object

com.mojang.datafixers.optics.Optic.CompositionOptic<Proof,S,T,A,B,A1,B1>

Type Parameters:

Proof - The profunctor type this optic evaluates. It shall be a subtype of the outer and inner optics' type.

S - The input object type.

T - The output object type.

A - The input field type.

B - The output field type.

A1 - The input subfield type.

B1 - The output subfield type.

All Implemented Interfaces:

Optic<Proof,S::A1,T::B1>

Enclosing interface:

Optic<Proof extends K1,S,T,A,B>

public static final class Optic.CompositionOptic<Proof extends K1,S,T,A,B,A1,B1>
extends Object
implements Optic<Proof,S::A1,T::B1>

An optic that represents the composition of two compatible optics. Two optics are compatible if

1. The profunctor types the two optics use have a common subtype.
2. The fields types of the first optic correspond to the object types of the second optic.

The composition acts on the objects of the first optic and the fields of the second optic.

Type Shape:

%.Type.[%0,%1::%3::%%5,%2::%4::%6]

Nested Class Summary

Nested classes/interfaces inherited from interface com.mojang.datafixers.optics.Optic

Optic.CompositionOptic<Proof extends K1,S,T,A,B,A1,B1>

Field Summary

Fields

Modifier and Type	Field and Description
protected Optic<? super Proof,A::A1,B::B1>	inner The inner optic, which acts on the field and subfield types.
protected Optic<? super Proof,S::A,T::B>	outer The outer optic, which acts on the object and field types.

Constructor Summary

Constructors

Constructor and Description
CompositionOptic(Optic<? super Proof,S::A,T::B> outer, Optic<? super Proof,A::A1,B::B1> inner) Constructs a new composition from the given compatible optics.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
<P extends K2> (P<A1,B1>) -> P<S,T>	eval(? extends Proof<P> proof) Applies the given Profunctor to this optic to produce a function that converts a transformation between the field types into a transformation between the object types.
int	hashCode()
Optic<? super Proof,A::A1,B::B1>	inner() Returns the inner optic, which acts on the field and subfield types.
Optic<? super Proof,S::A,T::B>	outer() Returns the outer optic, which acts on the object and field types.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mojang.datafixers.optics.Optic

compose, composeUnchecked, upCast

Field Detail

outer

protected final Optic<? super Proof extends K1,S::A,T::B> outer

The outer optic, which acts on the object and field types.

inner

protected final Optic<? super Proof extends K1,A::A1,B::B1> inner

The inner optic, which acts on the field and subfield types.

Constructor Detail

CompositionOptic

public CompositionOptic(Optic<? super Proof,S::A,T::B> outer,
                        Optic<? super Proof,A::A1,B::B1> inner)

Constructs a new composition from the given compatible optics.

Parameters:

outer - The outer optic.

inner - The inner optic.

Method Detail

eval

public <P extends K2> (P<A1,B1>) -> P<S,T> eval(? extends Proof<P> proof)

Description copied from interface: Optic

Applies the given Profunctor to this optic to produce a function that converts a transformation between the field types into a transformation between the object types.

Specified by:

eval in interface Optic<Proof extends K1,S::A1,T::B1>

Type Parameters:

P - The type associated with the profunctor.

Parameters:

proof - The profunctor associated with this optic.

Returns:

A function that ultimately transforms the input object into the output object, given a transformation from the input field to the output field.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

outer

public Optic<? super Proof,S::A,T::B> outer()

Returns the outer optic, which acts on the object and field types.

inner

public Optic<? super Proof,A::A1,B::B1> inner()

Returns the inner optic, which acts on the field and subfield types.