java.lang.Object
- io.atlassian.fugue.optic.PIso<S,T,A,B>

Type Parameters:: S - the source of a PIso; T - the modified source of a PIso; A - the target of a PIso; B - the modified target of a PIso

Direct Known Subclasses:: Iso

public abstract class PIso<S,T,A,B>
extends java.lang.Object

A PIso defines an isomorphism between types S, A and B, T:

              get                           reverse.get
     -------------------->             -------------------->
   S                       A         T                       B
     <--------------------             <--------------------
       reverse.reverseGet                   reverseGet

In addition, if f and g forms an isomorphism between `A` and `B`, i.e. if `f . g = id` and `g . f = id`, then a PIso defines an isomorphism between `S` and `T`:

     S           T                                   S           T
     |           ↑                                   ↑           |
     |           |                                   |           |
 get |           | reverseGet     reverse.reverseGet |           | reverse.get
     |           |                                   |           |
     ↓     f     |                                   |     g     ↓
     A --------> B                                   A <-------- B

A PIso is also a valid Getter, Fold, PLens, PPrism, POptional, PTraversal and PSetter

Constructor Summary

Constructors
Constructor Description

PIso()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Fold<S,A>`	`asFold()`	view a `PIso` as a `Fold`
`Getter<S,A>`	`asGetter()`	view a `PIso` as a `Getter`
`PLens<S,T,A,B>`	`asLens()`	view a `PIso` as a `PLens`
`POptional<S,T,A,B>`	`asOptional()`	view a `PIso` as a `POptional`
`PPrism<S,T,A,B>`	`asPrism()`	view a `PIso` as a `PPrism`
`PSetter<S,T,A,B>`	`asSetter()`	view a `PIso` as a `Setter`
`PTraversal<S,T,A,B>`	`asTraversal()`	view a `PIso` as a `PTraversal`
`<C> Fold<S,C>`	`composeFold(Fold<A,C> other)`	compose a `PIso` with a `Fold`
`<C> Getter<S,C>`	`composeGetter(Getter<A,C> other)`	compose a `PIso` with a `Getter`
`<C,D> PIso<S,T,C,D>`	`composeIso(PIso<A,B,C,D> other)`	compose a `PIso` with a `PIso`
`<C,D> PLens<S,T,C,D>`	`composeLens(PLens<A,B,C,D> other)`	compose a `PIso` with a `PLens`
`<C,D> POptional<S,T,C,D>`	`composeOptional(POptional<A,B,C,D> other)`	compose a `PIso` with a `POptional`
`<C,D> PPrism<S,T,C,D>`	`composePrism(PPrism<A,B,C,D> other)`	compose a `PIso` with a `PPrism`
`<C,D> PSetter<S,T,C,D>`	`composeSetter(PSetter<A,B,C,D> other)`	compose a `PIso` with a `PSetter`
`<C,D> PTraversal<S,T,C,D>`	`composeTraversal(PTraversal<A,B,C,D> other)`	compose a `PIso` with a `PTraversal`
`<C> PIso<Pair<S,C>,Pair<T,C>,Pair<A,C>,Pair<B,C>>`	`first()`
`abstract A`	`get(S s)`	get the target of a `PIso`
`java.util.function.Function<S,T>`	`modify(java.util.function.Function<A,B> f)`	modify polymorphically the target of a `PIso` with a function
`<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 `PIso` with an Applicative function
`<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 `PIso` with an Applicative function
`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 `PIso` with an Applicative function
`java.util.function.Function<S,Option<T>>`	`modifyOptionF(java.util.function.Function<A,Option<B>> f)`	modify polymorphically the target of a `PIso` with an Applicative function
`java.util.function.Function<S,Pair<T,T>>`	`modifyPairF(java.util.function.Function<A,Pair<B,B>> f)`	modify polymorphically the target of a `PIso` with an Applicative function
`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 `PIso` with an Applicative function
`static <S,T> PIso<S,T,S,T>`	`pId()`	create a `PIso` between any type and itself.
`static <S,T,A,B> PIso<S,T,A,B>`	`pIso(java.util.function.Function<S,A> get, java.util.function.Function<B,T> reverseGet)`	create a `PIso` using a pair of functions: one to get the target and one to get the source.
`<S1,T1,A1,B1> PIso<Pair<S,S1>,Pair<T,T1>,Pair<A,A1>,Pair<B,B1>>`	`product(PIso<S1,T1,A1,B1> other)`	pair two disjoint `PIso`
`abstract PIso<B,A,T,S>`	`reverse()`	reverse a `PIso`: the source becomes the target and the target becomes the source
`abstract T`	`reverseGet(B b)`	get the modified source of a `PIso`
`<C> PIso<Pair<C,S>,Pair<C,T>,Pair<C,A>,Pair<C,B>>`	`second()`
`java.util.function.Function<S,T>`	`set(B b)`	set polymorphically the target of a `PIso` with a value

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PIso
```
PIso()
```

Method Detail

get
```
public abstract A get(S s)
```
get the target of a PIso

reverseGet
```
public abstract T reverseGet(B b)
```
get the modified source of a PIso

reverse
```
public abstract PIso<B,A,T,S> reverse()
```
reverse a PIso: the source becomes the target and the target becomes the source