io.atlassian.fugue.optic

Class PSetter<S,T,A,B>

java.lang.Object

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

Type Parameters:

S - the source of a PSetter

T - the modified source of a PSetter

A - the target of a PSetter

B - the modified target of a PSetter

Direct Known Subclasses:

Setter

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

A PSetter is a generalisation of Functor map: - `map: (A => B) => F[A] => F[B]` - `modify: (A => B) => S => T`

PSetter stands for Polymorphic Setter as it set and modify methods change a type `A` to `B` and `S` to `T`.

PTraversal, POptional, PPrism, PLens and PIso are valid PSetter

Method Summary

Modifier and Type	Method and Description
<C,D> PSetter<S,T,C,D>	composeIso(PIso<A,B,C,D> other) compose a PSetter with a PIso
<C,D> PSetter<S,T,C,D>	composeLens(PLens<A,B,C,D> other) compose a PSetter with a PLens
<C,D> PSetter<S,T,C,D>	composeOptional(POptional<A,B,C,D> other) compose a PSetter with a POptional
<C,D> PSetter<S,T,C,D>	composePrism(PPrism<A,B,C,D> other) compose a PSetter with a PPrism
<C,D> PSetter<S,T,C,D>	composeSetter(PSetter<A,B,C,D> other) compose a PSetter with a PSetter
<C,D> PSetter<S,T,C,D>	composeTraversal(PTraversal<A,B,C,D> other) compose a PSetter with a PTraversal
abstract Function<S,T>	modify(Function<A,B> f) modify polymorphically the target of a PSetter with a function
static <S,T> PSetter<Either<S,S>,Either<T,T>,S,T>	pCodiagonal()
static <S,T> PSetter<S,T,S,T>	pId()
static <S,T,A,B> PSetter<S,T,A,B>	pSetter(Function<Function<A,B>,Function<S,T>> modify)
abstract Function<S,T>	set(B b) set polymorphically the target of a PSetter with a value
<S1,T1> PSetter<Either<S,S1>,Either<T,T1>,A,B>	sum(PSetter<S1,T1,A,B> other) join two PSetter with the same target

Methods inherited from class java.lang.Object

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

Method Detail

modify

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

modify polymorphically the target of a PSetter with a function

set

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

set polymorphically the target of a PSetter with a value

sum

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

join two PSetter with the same target

composeSetter

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

compose a PSetter with a PSetter

composeTraversal

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

compose a PSetter with a PTraversal

composeOptional

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

compose a PSetter with a POptional

composePrism

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

compose a PSetter with a PPrism

composeLens

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

compose a PSetter with a PLens

composeIso

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

compose a PSetter with a PIso

pId

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

pCodiagonal

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

pSetter

public static <S,T,A,B> PSetter<S,T,A,B> pSetter(Function<Function<A,B>,Function<S,T>> modify)