Package io.atlassian.fugue.optic

Class Optional<S,A>

java.lang.Object

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

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

public final class Optional<S,A>
extends POptional<S,S,A,A>

POptional restricted to monomorphic update

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final POptional<S,S,A,A>	pOptional

Constructor Summary

Constructors

Constructor	Description
Optional(POptional<S,S,A,A> pOptional)

Method Summary

Modifier and Type	Method	Description
final Setter<S,A>	asSetter()	view a Optional as a Setter
final Traversal<S,A>	asTraversal()	view a Optional as a Traversal
final <C> Optional<S,C>	composeIso(Iso<A,C> other)	compose a Optional with an Iso
final <C> Optional<S,C>	composeLens(Lens<A,C> other)	compose a Optional with a Lens
final <C> Optional<S,C>	composeOptional(Optional<A,C> other)	compose a Optional with a Optional
final <C> Optional<S,C>	composePrism(Prism<A,C> other)	compose a Optional with a Prism
final <C> Setter<S,C>	composeSetter(Setter<A,C> other)	compose a Optional with a Setter
final <C> Traversal<S,C>	composeTraversal(Traversal<A,C> other)	compose a Optional with a Traversal
final <C> Optional<Pair<S,C>,Pair<A,C>>	first()
Option<A>	getOption(S s)	get the target of a POptional or nothing if there is no target
Either<S,A>	getOrModify(S s)	get the target of a POptional or modify the source in case there is no target
static <S> Optional<S,S>	id()
Function<S,S>	modify(Function<A,A> f)	modify polymorphically the target of a POptional with a function
<L> Function<S,Either<L,S>>	modifyEitherF(Function<A,Either<L,A>> f)	modify polymorphically the target of a POptional with an Applicative function
<C> Function<S,Function<C,S>>	modifyFunctionF(Function<A,Function<C,A>> f)	modify polymorphically the target of a POptional with an Applicative function
Function<S,Iterable<S>>	modifyIterableF(Function<A,Iterable<A>> f)	modify polymorphically the target of a POptional with an Applicative function
Function<S,Option<S>>	modifyOptionF(Function<A,Option<A>> f)	modify polymorphically the target of a POptional with an Applicative function
Function<S,Pair<S,S>>	modifyPairF(Function<A,Pair<A,A>> f)	modify polymorphically the target of a POptional with an Applicative function
Function<S,Supplier<S>>	modifySupplierF(Function<A,Supplier<A>> f)	modify polymorphically the target of a POptional with an Applicative function
static <S, A> Optional<S,A>	optional(Function<S,Option<A>> getOption, Function<A,Function<S,S>> set)
final <C> Optional<Pair<C,S>,Pair<C,A>>	second()
Function<S,S>	set(A a)	get the modified source of a POptional
final <S1> Optional<Either<S,S1>,A>	sum(Optional<S1,A> other)	join two Optional with the same target

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

asFold, composeFold, composeGetter, composeIso, composeLens, composeOptional, composePrism, composeSetter, composeTraversal, isMatching, modifyOption, pId, pOptional, setOption, sum

Methods inherited from class java.lang.Object

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

Field Details

pOptional

final POptional<S,S,A,A> pOptional

Constructor Details

Optional

public Optional(POptional<S,S,A,A> pOptional)

Method Details

set

public Function<S,S> set(A a)

Description copied from class: POptional

get the modified source of a POptional

Specified by:

set in class POptional<S,S,A,A>

modifySupplierF

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

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

modifySupplierF in class POptional<S,S,A,A>

modifyOptionF

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

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

modifyOptionF in class POptional<S,S,A,A>

modifyFunctionF

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

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

modifyFunctionF in class POptional<S,S,A,A>

modifyEitherF

public <L> Function<S,Either<L,S>> modifyEitherF(Function<A,Either<L,A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

modifyEitherF in class POptional<S,S,A,A>

modifyIterableF

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

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

modifyIterableF in class POptional<S,S,A,A>

modifyPairF

public Function<S,Pair<S,S>> modifyPairF(Function<A,Pair<A,A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

modifyPairF in class POptional<S,S,A,A>

modify

public Function<S,S> modify(Function<A,A> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with a function

Specified by:

modify in class POptional<S,S,A,A>

getOrModify

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

Description copied from class: POptional

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

Specified by:

getOrModify in class POptional<S,S,A,A>

getOption

public Option<A> getOption(S s)

Description copied from class: POptional

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

Specified by:

getOption in class POptional<S,S,A,A>

sum

public final <S1> Optional<Either<S,S1>,A> sum(Optional<S1,A> other)

join two Optional with the same target

first

public final <C> Optional<Pair<S,C>,Pair<A,C>> first()

Overrides:

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

second

public final <C> Optional<Pair<C,S>,Pair<C,A>> second()

Overrides:

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

composeSetter

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

compose a Optional with a Setter

composeTraversal

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

compose a Optional with a Traversal

composeOptional

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

compose a Optional with a Optional

composePrism

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

compose a Optional with a Prism

composeLens

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

compose a Optional with a Lens

composeIso

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

compose a Optional with an Iso

asSetter

public final Setter<S,A> asSetter()

view a Optional as a Setter

Overrides:

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

asTraversal

public final Traversal<S,A> asTraversal()

view a Optional as a Traversal

Overrides:

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

id

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

optional

public static <S,
A> Optional<S,A> optional(Function<S,Option<A>> getOption,
 Function<A,Function<S,S>> set)