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 java.lang.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

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`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`
`<C> Fold<S,C>`	`composeFold(Fold<A,C> other)`	compose a `POptional` with a `Fold`
`<C> Fold<S,C>`	`composeGetter(Getter<A,C> other)`	compose a `POptional` with a `Getter`
`<C,D> POptional<S,T,C,D>`	`composeIso(PIso<A,B,C,D> other)`	compose a `POptional` with a `PIso`
`<C,D> POptional<S,T,C,D>`	`composeLens(PLens<A,B,C,D> other)`	compose a `POptional` with a `PLens`
`<C,D> POptional<S,T,C,D>`	`composeOptional(POptional<A,B,C,D> other)`	compose a `POptional` with a `POptional`
`<C,D> POptional<S,T,C,D>`	`composePrism(PPrism<A,B,C,D> other)`	compose a `POptional` with a `PPrism`
`<C,D> PSetter<S,T,C,D>`	`composeSetter(PSetter<A,B,C,D> other)`	compose a `POptional` with a `PSetter`
`<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
`boolean`	`isMatching(S s)`	check if a `POptional` has a target
`abstract java.util.function.Function<S,T>`	`modify(java.util.function.Function<A,B> f)`	modify polymorphically the target of a `POptional` with a function
`abstract <L> java.util.function.Function<S,Either<L,T>>`	`modifyEitherF(java.util.function.Function<A,Either<L,B>> f)`	modify polymorphically the target of a `POptional` with an Applicative function
`abstract <C> java.util.function.Function<S,java.util.function.Function<C,T>>`	`modifyFunctionF(java.util.function.Function<A,java.util.function.Function<C,B>> f)`	modify polymorphically the target of a `POptional` with an Applicative function
`abstract java.util.function.Function<S,java.lang.Iterable<T>>`	`modifyIterableF(java.util.function.Function<A,java.lang.Iterable<B>> f)`	modify polymorphically the target of a `POptional` with an Applicative function
`java.util.function.Function<S,Option<T>>`	`modifyOption(java.util.function.Function<A,B> f)`	modify polymorphically the target of a `POptional` with a function.
`abstract java.util.function.Function<S,Option<T>>`	`modifyOptionF(java.util.function.Function<A,Option<B>> f)`	modify polymorphically the target of a `POptional` with an Applicative function
`abstract java.util.function.Function<S,Pair<T,T>>`	`modifyPairF(java.util.function.Function<A,Pair<B,B>> f)`	modify polymorphically the target of a `POptional` with an Applicative function
`abstract java.util.function.Function<S,java.util.function.Supplier<T>>`	`modifySupplierF(java.util.function.Function<A,java.util.function.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(java.util.function.Function<S,Either<T,A>> getOrModify, java.util.function.Function<B,java.util.function.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 java.util.function.Function<S,T>`	`set(B b)`	get the modified source of a `POptional`
`java.util.function.Function<S,Option<T>>`	`setOption(B b)`	set polymorphically the target of a `POptional` with a value.
`<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 Detail
- POptional
```
POptional()
```

Method Detail

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 java.util.function.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