io.atlassian.fugue.optic

Class Iso<S,A>

java.lang.Object

io.atlassian.fugue.optic.PIso<S,S,A,A>

io.atlassian.fugue.optic.Iso<S,A>

public final class Iso<S,A>
extends PIso<S,S,A,A>

PIso when S = T and A = B

Constructor Summary

Constructors

Constructor and Description
Iso(PIso<S,S,A,A> pIso)

Method Summary

Modifier and Type	Method and Description
Lens<S,A>	asLens() view an Iso as a Lens
Optional<S,A>	asOptional() view an Iso as a Optional
Prism<S,A>	asPrism() view an Iso as a Prism
Setter<S,A>	asSetter() view an Iso as a Setter
Traversal<S,A>	asTraversal() view an Iso as a Traversal
<C> Iso<S,C>	composeIso(Iso<A,C> other) compose an Iso with an Iso
<C> Lens<S,C>	composeLens(Lens<A,C> other) compose an Iso with a Lens
<C> Optional<S,C>	composeOptional(Optional<A,C> other) compose an Iso with a Optional
<C> Prism<S,C>	composePrism(Prism<A,C> other) compose an Iso with a Prism
<C> Setter<S,C>	composeSetter(Setter<A,C> other) compose an Iso with a Setter
<C> Traversal<S,C>	composeTraversal(Traversal<A,C> other) compose an Iso with a Traversal
<C> Iso<Pair<S,C>,Pair<A,C>>	first()
A	get(S s) get the target of a PIso
static <S> Iso<S,S>	id() create an Iso between any type and itself.
static <S,A> Iso<S,A>	iso(Function<S,A> get, Function<A,S> reverseGet) create an Iso using a pair of functions: one to get the target and one to get the source.
<S1,A1> Iso<Pair<S,S1>,Pair<A,A1>>	product(Iso<S1,A1> other) pair two disjoint Iso
Iso<A,S>	reverse() reverse a PIso: the source becomes the target and the target becomes the source
S	reverseGet(A a) get the modified source of a PIso
<C> Iso<Pair<C,S>,Pair<C,A>>	second()

Methods inherited from class io.atlassian.fugue.optic.PIso

asFold, asGetter, composeFold, composeGetter, composeIso, composeLens, composeOptional, composePrism, composeSetter, composeTraversal, modify, modifyEitherF, modifyFunctionF, modifyIterableF, modifyOptionF, modifyPairF, modifySupplierF, pId, pIso, product, set

Methods inherited from class java.lang.Object

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

Constructor Detail

Iso

public Iso(PIso<S,S,A,A> pIso)

Method Detail

get

public A get(S s)

Description copied from class: PIso

get the target of a PIso

Specified by:

get in class PIso<S,S,A,A>

reverseGet

public S reverseGet(A a)

Description copied from class: PIso

get the modified source of a PIso

Specified by:

reverseGet in class PIso<S,S,A,A>

reverse

public Iso<A,S> reverse()

Description copied from class: PIso

reverse a PIso: the source becomes the target and the target becomes the source

Specified by:

reverse in class PIso<S,S,A,A>

product

public <S1,A1> Iso<Pair<S,S1>,Pair<A,A1>> product(Iso<S1,A1> other)

pair two disjoint Iso

first

public <C> Iso<Pair<S,C>,Pair<A,C>> first()

Overrides:

first in class PIso<S,S,A,A>

second

public <C> Iso<Pair<C,S>,Pair<C,A>> second()

Overrides:

second in class PIso<S,S,A,A>

composeSetter

public final <C> Setter<S,C> composeSetter(Setter<A,C> other)

compose an Iso with a Setter

composeTraversal

public final <C> Traversal<S,C> composeTraversal(Traversal<A,C> other)

compose an Iso with a Traversal

composeOptional

public final <C> Optional<S,C> composeOptional(Optional<A,C> other)

compose an Iso with a Optional

composePrism

public final <C> Prism<S,C> composePrism(Prism<A,C> other)

compose an Iso with a Prism

composeLens

public final <C> Lens<S,C> composeLens(Lens<A,C> other)

compose an Iso with a Lens

composeIso

public final <C> Iso<S,C> composeIso(Iso<A,C> other)

compose an Iso with an Iso

asSetter

public final Setter<S,A> asSetter()

view an Iso as a Setter

Overrides:

asSetter in class PIso<S,S,A,A>

asTraversal

public final Traversal<S,A> asTraversal()

view an Iso as a Traversal

Overrides:

asTraversal in class PIso<S,S,A,A>

asOptional

public final Optional<S,A> asOptional()

view an Iso as a Optional

Overrides:

asOptional in class PIso<S,S,A,A>

asPrism

public final Prism<S,A> asPrism()

view an Iso as a Prism

Overrides:

asPrism in class PIso<S,S,A,A>

asLens

public final Lens<S,A> asLens()

view an Iso as a Lens

Overrides:

asLens in class PIso<S,S,A,A>

iso

public static <S,A> Iso<S,A> iso(Function<S,A> get,
                                 Function<A,S> reverseGet)

create an Iso using a pair of functions: one to get the target and one to get the source.

id

public static <S> Iso<S,S> id()

create an Iso between any type and itself. id is the zero element of optics composition, for all optics o of type O (e.g. Lens, Iso, Prism, ...):

  o composeIso Iso.id == o
  Iso.id composeO o == o
 

(replace composeO by composeLens, composeIso, composePrism, ...)