Package io.atlassian.fugue.optic

Class POptional<S,T,A,B>

java.lang.Object

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

Type Parameters:

S - the source of a POptional

T - the modified source of a POptional

A - the target of a POptional

B - the modified target of a POptional

Direct Known Subclasses:

Optional

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

A POptional can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `set : (B, S) => T`

A POptional could also be defined as a weaker PLens and weaker PPrism

POptional stands for Polymorphic Optional as it set and modify methods change a type `A` to `B` and `S` to `T`. Optional is a POptional restricted to monomorphic updates: {{{ type Optional[S, A] = POptional[S, S, A, A] }}}

Constructor Summary

Constructors

Constructor	Description
POptional()

Method Summary

Modifier and Type	Method	Description
final Fold<S,A>	asFold()	view a POptional as a Fold
PSetter<S,T,A,B>	asSetter()	view a POptional as a PSetter
PTraversal<S,T,A,B>	asTraversal()	view a POptional as a PTraversal
final <C> Fold<S,C>	composeFold(Fold<A,C> other)	compose a POptional with a Fold
final <C> Fold<S,C>	composeGetter(Getter<A,C> other)	compose a POptional with a Getter
final <C, D> POptional<S,T,C,D>	composeIso(PIso<A,B,C,D> other)	compose a POptional with a PIso
final <C, D> POptional<S,T,C,D>	composeLens(PLens<A,B,C,D> other)	compose a POptional with a PLens
final <C, D> POptional<S,T,C,D>	composeOptional(POptional<A,B,C,D> other)	compose a POptional with a POptional
final <C, D> POptional<S,T,C,D>	composePrism(PPrism<A,B,C,D> other)	compose a POptional with a PPrism
final <C, D> PSetter<S,T,C,D>	composeSetter(PSetter<A,B,C,D> other)	compose a POptional with a PSetter
final <C, D> PTraversal<S,T,C,D>	composeTraversal(PTraversal<A,B,C,D> other)	compose a POptional with a PTraversal
<C> POptional<Pair<S,C>,Pair<T,C>,Pair<A,C>,Pair<B,C>>	first()
abstract Option<A>	getOption(S s)	get the target of a POptional or nothing if there is no target
abstract Either<T,A>	getOrModify(S s)	get the target of a POptional or modify the source in case there is no target
final boolean	isMatching(S s)	check if a POptional has a target
abstract Function<S,T>	modify(Function<A,B> f)	modify polymorphically the target of a POptional with a function
abstract <L> Function<S,Either<L,T>>	modifyEitherF(Function<A,Either<L,B>> f)	modify polymorphically the target of a POptional with an Applicative function
abstract <C> Function<S,Function<C,T>>	modifyFunctionF(Function<A,Function<C,B>> f)	modify polymorphically the target of a POptional with an Applicative function
abstract Function<S,Iterable<T>>	modifyIterableF(Function<A,Iterable<B>> f)	modify polymorphically the target of a POptional with an Applicative function
final Function<S,Option<T>>	modifyOption(Function<A,B> f)	modify polymorphically the target of a POptional with a function.
abstract Function<S,Option<T>>	modifyOptionF(Function<A,Option<B>> f)	modify polymorphically the target of a POptional with an Applicative function
abstract Function<S,Pair<T,T>>	modifyPairF(Function<A,Pair<B,B>> f)	modify polymorphically the target of a POptional with an Applicative function
abstract Function<S,Supplier<T>>	modifySupplierF(Function<A,Supplier<B>> f)	modify polymorphically the target of a POptional with an Applicative function
static <S, T> POptional<S,T,S,T>	pId()
static <S, T, A, B> POptional<S,T,A,B>	pOptional(Function<S,Either<T,A>> getOrModify, Function<B,Function<S,T>> set)	create a POptional using the canonical functions: getOrModify and set
<C> POptional<Pair<C,S>,Pair<C,T>,Pair<C,A>,Pair<C,B>>	second()
abstract Function<S,T>	set(B b)	get the modified source of a POptional
final Function<S,Option<T>>	setOption(B b)	set polymorphically the target of a POptional with a value.
final <S1, T1> POptional<Either<S,S1>,Either<T,T1>,A,B>	sum(POptional<S1,T1,A,B> other)	join two POptional with the same target

Methods inherited from class java.lang.Object

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

Constructor Details

POptional

POptional()

Method Details

getOrModify

public abstract Either<T,A> getOrModify(S s)

get the target of a POptional or modify the source in case there is no target

set

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

get the modified source of a POptional

getOption

public abstract Option<A> getOption(S s)

get the target of a POptional or nothing if there is no target

modifyFunctionF

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

modify polymorphically the target of a POptional 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 POptional with an Applicative function

modifyOptionF

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

modify polymorphically the target of a POptional 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 POptional with an Applicative function

modifySupplierF

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

modify polymorphically the target of a POptional with an Applicative function

modifyIterableF

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

modify polymorphically the target of a POptional with an Applicative function

modify

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

modify polymorphically the target of a POptional with a function

modifyOption

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

modify polymorphically the target of a POptional with a function. return empty if the POptional is not matching

setOption

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

set polymorphically the target of a POptional with a value. return empty if the POptional is not matching

isMatching

public final boolean isMatching(S s)

check if a POptional has a target

sum

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

join two POptional with the same target

first

public <C>
POptional<Pair<S,C>,Pair<T,C>,Pair<A,C>,Pair<B,C>> first()

second

public <C>
POptional<Pair<C,S>,Pair<C,T>,Pair<C,A>,Pair<C,B>> second()

composeFold

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

compose a POptional with a Fold

composeGetter

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

compose a POptional with a Getter

composeSetter

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

compose a POptional with a PSetter

composeTraversal

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

compose a POptional with a PTraversal

composeOptional

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

compose a POptional with a POptional

composePrism

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

compose a POptional with a PPrism

composeLens

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

compose a POptional with a PLens

composeIso

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

compose a POptional with a PIso

asFold

public final Fold<S,A> asFold()

view a POptional as a Fold

asSetter

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

view a POptional as a PSetter

asTraversal

public PTraversal<S,T,A,B> asTraversal()

view a POptional as a PTraversal

pId

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

pOptional

public static <S,
T,
A,
B> POptional<S,T,A,B> pOptional(Function<S,Either<T,A>> getOrModify,
 Function<B,Function<S,T>> set)

create a POptional using the canonical functions: getOrModify and set