io.atlassian.fugue.optic

Class PTraversal<S,T,A,B>

java.lang.Object

io.atlassian.fugue.optic.PTraversal<S,T,A,B>

Type Parameters:

S - the source of a PTraversal

T - the modified source of a PTraversal

A - the target of a PTraversal

B - the modified target of a PTraversal

Direct Known Subclasses:

Traversal

public abstract class PTraversal<S,T,A,B>
extends Object

A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.

PTraversal stands for Polymorphic Traversal as it set and modify methods change a type `A` to `B` and `S` to `T`. Traversal is a PTraversal restricted to monomorphic updates.

Constructor Summary

Constructors

Constructor and Description
PTraversal()

Method Summary

Modifier and Type	Method and Description
Predicate<S>	all(Predicate<A> p) check if all targets satisfy the predicate
Fold<S,A>	asFold() view a PTraversal as a Fold
PSetter<S,T,A,B>	asSetter() view a PTraversal as a PSetter
<C> Fold<S,C>	composeFold(Fold<A,C> other) compose a PTraversal with a Fold
<C> Fold<S,C>	composeFold(Getter<A,C> other) compose a PTraversal with a Getter
<C,D> PTraversal<S,T,C,D>	composeIso(PIso<A,B,C,D> other) compose a PTraversal with a PIso
<C,D> PTraversal<S,T,C,D>	composeLens(PLens<A,B,C,D> other) compose a PTraversal with a PLens
<C,D> PTraversal<S,T,C,D>	composeOptional(POptional<A,B,C,D> other) compose a PTraversal with a POptional
<C,D> PTraversal<S,T,C,D>	composePrism(PPrism<A,B,C,D> other) compose a PTraversal with a PPrism
<C,D> PSetter<S,T,C,D>	composeSetter(PSetter<A,B,C,D> other) compose a PTraversal with a PSetter
<C,D> PTraversal<S,T,C,D>	composeTraversal(PTraversal<A,B,C,D> other) compose a PTraversal with a PTraversal
Predicate<S>	exist(Predicate<A> p) check if at least one target satisfies the predicate
Function<S,Option<A>>	find(Predicate<A> p) find the first target of a PTraversal matching the predicate
Function<S,A>	fold(Monoid<A> monoid) combine all targets using a target's Monoid
abstract <M> Function<S,M>	foldMap(Monoid<M> monoid, Function<A,M> f) map each target to a Monoid and combine the results
Iterable<A>	getAll(S s) get all the targets of a PTraversal
Option<A>	headOption(S s) get the first target of a PTraversal
Function<S,T>	modify(Function<A,B> f) modify polymorphically the target of a PTraversal with a function
abstract <L> Function<S,Either<L,T>>	modifyEitherF(Function<A,Either<L,B>> f) modify polymorphically the target of a PTraversal with an Applicative function
abstract <C> Function<S,Function<C,T>>	modifyFunctionF(Function<A,Function<C,B>> f) modify polymorphically the target of a PTraversal with an Applicative function
abstract Function<S,Iterable<T>>	modifyIterableF(Function<A,Iterable<B>> f) modify polymorphically the target of a PTraversal with an Applicative function
abstract Function<S,Option<T>>	modifyOptionF(Function<A,Option<B>> f) modify polymorphically the target of a PTraversal with an Applicative function
abstract Function<S,Pair<T,T>>	modifyPairF(Function<A,Pair<B,B>> f) modify polymorphically the target of a PTraversal with an Applicative function
abstract Function<S,Supplier<T>>	modifySupplierF(Function<A,Supplier<B>> f) modify polymorphically the target of a PTraversal with an Applicative function
static <S,T> PTraversal<Either<S,S>,Either<T,T>,S,T>	pCodiagonal()
static <S,T> PTraversal<S,T,S,T>	pId()
static <S,T,A,B> PTraversal<S,T,A,B>	pTraversal(Function<S,A> get1, Function<S,A> get2, BiFunction<B,B,Function<S,T>> set)
static <S,T,A,B> PTraversal<S,T,A,B>	pTraversal(Function<S,A> get1, Function<S,A> get2, Function<S,A> get3, Function<B,Function<B,Function<B,Function<S,T>>>> set)
static <S,T,A,B> PTraversal<S,T,A,B>	pTraversal(Function<S,A> get1, Function<S,A> get2, Function<S,A> get3, Function<S,A> get4, Function<B,Function<B,Function<B,Function<B,Function<S,T>>>>> set)
static <S,T,A,B> PTraversal<S,T,A,B>	pTraversal(Function<S,A> get1, Function<S,A> get2, Function<S,A> get3, Function<S,A> get4, Function<S,A> get5, Function<B,Function<B,Function<B,Function<B,Function<B,Function<S,T>>>>>> set)
static <S,T,A,B> PTraversal<S,T,A,B>	pTraversal(Function<S,A> get1, Function<S,A> get2, Function<S,A> get3, Function<S,A> get4, Function<S,A> get5, Function<S,A> get6, Function<B,Function<B,Function<B,Function<B,Function<B,Function<B,Function<S,T>>>>>>> set)
Function<S,T>	set(B b) set polymorphically the target of a PTraversal with a value
<S1,T1> PTraversal<Either<S,S1>,Either<T,T1>,A,B>	sum(PTraversal<S1,T1,A,B> other) join two PTraversal with the same target

Methods inherited from class java.lang.Object

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

Constructor Detail

PTraversal

public PTraversal()

Method Detail

modifyFunctionF

public abstract <C> Function<S,Function<C,T>> modifyFunctionF(Function<A,Function<C,B>> f)

modify polymorphically the target of a PTraversal with an Applicative function

modifyEitherF

public abstract <L> Function<S,Either<L,T>> modifyEitherF(Function<A,Either<L,B>> f)

modify polymorphically the target of a PTraversal with an Applicative function

modifyOptionF

public abstract Function<S,Option<T>> modifyOptionF(Function<A,Option<B>> f)

modify polymorphically the target of a PTraversal with an Applicative function

modifyIterableF

public abstract Function<S,Iterable<T>> modifyIterableF(Function<A,Iterable<B>> f)

modify polymorphically the target of a PTraversal with an Applicative function

modifySupplierF

public abstract Function<S,Supplier<T>> modifySupplierF(Function<A,Supplier<B>> f)

modify polymorphically the target of a PTraversal with an Applicative function

modifyPairF

public abstract Function<S,Pair<T,T>> modifyPairF(Function<A,Pair<B,B>> f)

modify polymorphically the target of a PTraversal with an Applicative function

foldMap

public abstract <M> Function<S,M> foldMap(Monoid<M> monoid,
                                          Function<A,M> f)

map each target to a Monoid and combine the results

fold

public final Function<S,A> fold(Monoid<A> monoid)

combine all targets using a target's Monoid

getAll

public final Iterable<A> getAll(S s)

get all the targets of a PTraversal

find

public final Function<S,Option<A>> find(Predicate<A> p)

find the first target of a PTraversal matching the predicate

headOption

public final Option<A> headOption(S s)

get the first target of a PTraversal

exist

public final Predicate<S> exist(Predicate<A> p)

check if at least one target satisfies the predicate

all

public final Predicate<S> all(Predicate<A> p)

check if all targets satisfy the predicate

modify

public final Function<S,T> modify(Function<A,B> f)

modify polymorphically the target of a PTraversal with a function

set

public final Function<S,T> set(B b)

set polymorphically the target of a PTraversal with a value

sum

public final <S1,T1> PTraversal<Either<S,S1>,Either<T,T1>,A,B> sum(PTraversal<S1,T1,A,B> other)

join two PTraversal with the same target

composeFold

public final <C> Fold<S,C> composeFold(Fold<A,C> other)

compose a PTraversal with a Fold

composeFold

public final <C> Fold<S,C> composeFold(Getter<A,C> other)

compose a PTraversal with a Getter

composeSetter

public final <C,D> PSetter<S,T,C,D> composeSetter(PSetter<A,B,C,D> other)

compose a PTraversal with a PSetter

composeTraversal

public final <C,D> PTraversal<S,T,C,D> composeTraversal(PTraversal<A,B,C,D> other)

compose a PTraversal with a PTraversal

composeOptional

public final <C,D> PTraversal<S,T,C,D> composeOptional(POptional<A,B,C,D> other)

compose a PTraversal with a POptional

composePrism

public final <C,D> PTraversal<S,T,C,D> composePrism(PPrism<A,B,C,D> other)

compose a PTraversal with a PPrism

composeLens

public final <C,D> PTraversal<S,T,C,D> composeLens(PLens<A,B,C,D> other)

compose a PTraversal with a PLens

composeIso

public final <C,D> PTraversal<S,T,C,D> composeIso(PIso<A,B,C,D> other)

compose a PTraversal with a PIso

asFold

public final Fold<S,A> asFold()

view a PTraversal as a Fold

asSetter

public PSetter<S,T,A,B> asSetter()

view a PTraversal as a PSetter

pId

public static <S,T> PTraversal<S,T,S,T> pId()

pCodiagonal

public static <S,T> PTraversal<Either<S,S>,Either<T,T>,S,T> pCodiagonal()

pTraversal

public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(Function<S,A> get1,
                                                       Function<S,A> get2,
                                                       BiFunction<B,B,Function<S,T>> set)

pTraversal

public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(Function<S,A> get1,
                                                       Function<S,A> get2,
                                                       Function<S,A> get3,
                                                       Function<B,Function<B,Function<B,Function<S,T>>>> set)

pTraversal

public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(Function<S,A> get1,
                                                       Function<S,A> get2,
                                                       Function<S,A> get3,
                                                       Function<S,A> get4,
                                                       Function<B,Function<B,Function<B,Function<B,Function<S,T>>>>> set)

pTraversal

public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(Function<S,A> get1,
                                                       Function<S,A> get2,
                                                       Function<S,A> get3,
                                                       Function<S,A> get4,
                                                       Function<S,A> get5,
                                                       Function<B,Function<B,Function<B,Function<B,Function<B,Function<S,T>>>>>> set)

pTraversal

public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(Function<S,A> get1,
                                                       Function<S,A> get2,
                                                       Function<S,A> get3,
                                                       Function<S,A> get4,
                                                       Function<S,A> get5,
                                                       Function<S,A> get6,
                                                       Function<B,Function<B,Function<B,Function<B,Function<B,Function<B,Function<S,T>>>>>>> set)