com.mojang.datafixers.optics

Class Traversal.Instance<A2,B2>

java.lang.Object

com.mojang.datafixers.optics.Traversal.Instance<A2,B2>

Type Parameters:

A2 - The input field type.

B2 - The output field type.

All Implemented Interfaces:

TraversalP Traversal<_::A2,_::B2>, Kind2 Traversal<_::A2,_::B2>, AffineP Traversal<_::A2,_::B2>, Cartesian Traversal<_::A2,_::B2>, Cocartesian Traversal<_::A2,_::B2>, Profunctor Traversal<_::A2,_::B2>, TraversalP Traversal<_::A2,_::B2>

Enclosing interface:

Traversal<S,T,A,B>

public static final class Traversal.Instance<A2,B2>
extends Object
implements TraversalP Traversal<_::A2,_::B2>

The TraversalP type class instance for Traversal.

Type Shape:

instance %.Mu.[_::%0,_::%1]

Constructor Summary

Constructors

Constructor and Description
Instance()

Method Summary

Modifier and Type	Method and Description
<A,B,C,D> (Traversal<A::A2,B::B2>) -> Traversal<C::A2,D::B2>	dimap((C) -> A g, (B) -> D h) Takes a function from the output type C to the input type A and a function from the input type B to the output type D, and returns a function from a container of A, B to a container of C, D.
<S,T,A,B> Traversal<S::A2,T::B2>	wander(Wander<S::A,T::B> wander, Traversal<A::A2,B::B2> input) Takes an operation defined by Wander and a transformation between field types, and produces a transformation between object types.

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.optics.profunctors.TraversalP

first, left, toFP3, traverse

Methods inherited from interface com.mojang.datafixers.optics.profunctors.Cartesian

second, toFP2

Methods inherited from interface com.mojang.datafixers.optics.profunctors.Cocartesian

right, toFP

Methods inherited from interface com.mojang.datafixers.optics.profunctors.Profunctor

dimap, dimap, lmap, rmap

Constructor Detail

Instance

public Instance()

Method Detail

dimap

public <A,B,C,D> (Traversal<A::A2,B::B2>) -> Traversal<C::A2,D::B2> dimap((C) -> A g,
                                                                          (B) -> D h)

Description copied from interface: Profunctor

Takes a function from the output type C to the input type A and a function from the input type B to the output type D, and returns a function from a container of A, B to a container of C, D.

A straightforward example of an implementation of dimap is the method Function.andThen(Function). For functions, the expression

 dimap(g, h).apply(f)
 

is equivalent to

 g.andThen(f).andThen(h)
 

Specified by:

dimap in interface Profunctor Traversal<_::A2,_::B2>

Type Parameters:

A - The first input type.

B - The second input type.

C - The first output type.

D - The second output type.

Parameters:

g - A function from output to input.

h - A function from input to output.

Returns:

A function from an input container to an output container.

See Also:

Profunctor.dimap(App2, Function, Function)

wander

public <S,T,A,B> Traversal<S::A2,T::B2> wander(Wander<S::A,T::B> wander,
                                               Traversal<A::A2,B::B2> input)

Description copied from interface: TraversalP

Takes an operation defined by Wander and a transformation between field types, and produces a transformation between object types.

The returned transformation should accept an object S, extract a field A, apply the given input, and return the resulting B via an output object T, all in the context of some effectful computation defined by the wander.

Specified by:

wander in interface TraversalP Traversal<_::A2,_::B2>

Type Parameters:

S - The input object type.

T - The output object type.

A - The input field type.

B - The output field type.

Parameters:

wander - A mapping from effectful functions on the field types to effectful functions on the object types.

input - A (non-effectful) transformation between object types.

Returns:

A transformation between object types.

See Also:

Wander, Traversable