com.mojang.datafixers.optics

Interface Traversal<S,T,A,B>

Type Parameters:

S - The input object type.

T - The output object type.

A - The input field type.

B - The output field type.

All Superinterfaces:

Traversal<S::A,T::B>, Optic<TraversalP _,S::A,T::B>, Wander<S::A,T::B>

All Known Implementing Classes:

ListTraversal

public interface Traversal<S,T,A,B>
extends Wander<S::A,T::B>, Optic<TraversalP _,S::A,T::B>

A traversal is an optic that implements a structure-preserving transformation for (i.e. traverses over) some field of an object. It provides functionality to traverse over some fields of a structure and to transform those fields in the context of an effect.

The operation performed by traversals is analogous to Traversable, which defines a structure-preserving transformation in the context of an effectful transformation.

Type Shape:

%.Type.[%0::%2,%1::%3]

See Also:

Traversable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Traversal.Instance<A2,B2> The TraversalP type class instance for Traversal.

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

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

Method Summary

Modifier and Type	Method and Description
default <P extends K2> (P<A,B>) -> P<S,T>	eval(TraversalP P proof) Produces a function that takes a transformation between field types and produces a transformation between object types.

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

wander

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

compose, composeUnchecked, upCast

Method Detail

eval

default <P extends K2> (P<A,B>) -> P<S,T> eval(TraversalP P proof)

Produces a function that takes a transformation between field types and produces a transformation between object types. The returned function uses this traversal to traverse the object types and find each applicable field.

Specified by:

eval in interface Optic<TraversalP _,S::A,T::B>

Type Parameters:

P - The transformation type.

Parameters:

proof - The profunctor associated with this optic.

Returns:

A function from field transformations to object transformations.

See Also:

Wander.wander(Applicative, FunctionType)