Class Optional<S,A>

java.lang.Object

fj.data.optic.POptional<S,S,A,A>

fj.data.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
Setter<S,A>	asSetter()	view a Optional as a Setter
Traversal<S,A>	asTraversal()	view a Optional as a Traversal
<C> Optional<S,C>	composeIso(Iso<A,C> other)	compose a Optional with an Iso
<C> Optional<S,C>	composeLens(Lens<A,C> other)	compose a Optional with a Lens
<C> Optional<S,C>	composeOptional(Optional<A,C> other)	compose a Optional with a Optional
<C> Optional<S,C>	composePrism(Prism<A,C> other)	compose a Optional with a Prism
<C> Setter<S,C>	composeSetter(Setter<A,C> other)	compose a Optional with a Setter
<C> Traversal<S,C>	composeTraversal(Traversal<A,C> other)	compose a Optional with a Traversal
<C> Optional<P2<S,C>,P2<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()
static <S,A> Optional<S,A>	ignored()
F<S,S>	modify(F<A,A> f)	modify polymorphically the target of a POptional with a function
<L> F<S, Either<L,S>>	modifyEitherF(F<A, Either<L,A>> f)	modify polymorphically the target of a POptional with an Applicative function
<C> F<S,F<C,S>>	modifyFunctionF(F<A,F<C,A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S,IO<S>>	modifyIOF(F<A,IO<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S,List<S>>	modifyListF(F<A,List<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S, Option<S>>	modifyOptionF(F<A, Option<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S,P1<S>>	modifyP1F(F<A,P1<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S, Promise<S>>	modifyPromiseF(F<A, Promise<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S, Stream<S>>	modifyStreamF(F<A, Stream<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S, Trampoline<S>>	modifyTrampolineF(F<A, Trampoline<A>> f)	modify polymorphically the target of a POptional with an Applicative function
F<S,V2<S>>	modifyV2F(F<A,V2<A>> f)	modify polymorphically the target of a POptional with an Applicative function
<E> F<S, Validation<E,S>>	modifyValidationF(F<A, Validation<E,A>> f)	modify polymorphically the target of a POptional with an Applicative function
static final <S,A> Optional<S,A>	optional(F<S, Option<A>> getOption, F<A,F<S,S>> set)
<C> Optional<P2<C,S>,P2<C,A>>	second()
F<S,S>	set(A a)	get the modified source of a POptional
<S1> Optional<Either<S,S1>, A>	sum(Optional<S1,A> other)	join two Optional with the same target

Methods inherited from class POptional

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

Methods inherited from class 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 F<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>

modifyValidationF

public <E> F<S, Validation<E,S>> modifyValidationF(F<A, Validation<E,A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyV2F

public F<S,V2<S>> modifyV2F(F<A,V2<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyTrampolineF

public F<S, Trampoline<S>> modifyTrampolineF(F<A, Trampoline<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyStreamF

public F<S, Stream<S>> modifyStreamF(F<A, Stream<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyPromiseF

public F<S, Promise<S>> modifyPromiseF(F<A, Promise<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyP1F

public F<S,P1<S>> modifyP1F(F<A,P1<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyOptionF

public F<S, Option<S>> modifyOptionF(F<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>

modifyListF

public F<S,List<S>> modifyListF(F<A,List<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyIOF

public F<S,IO<S>> modifyIOF(F<A,IO<A>> f)

Description copied from class: POptional

modify polymorphically the target of a POptional with an Applicative function

Specified by:

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

modifyFunctionF

public <C> F<S,F<C,S>> modifyFunctionF(F<A,F<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> F<S, Either<L,S>> modifyEitherF(F<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>

modify

public F<S,S> modify(F<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 <S1> Optional<Either<S,S1>, A> sum(Optional<S1,A> other)

join two Optional with the same target

first

public <C> Optional<P2<S,C>,P2<A,C>> first()

Overrides:

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

second

public <C> Optional<P2<C,S>,P2<C,A>> second()

Overrides:

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

composeSetter

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

compose a Optional with a Setter

composeTraversal

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

compose a Optional with a Traversal

composeOptional

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

compose a Optional with a Optional

composePrism

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

compose a Optional with a Prism

composeLens

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

compose a Optional with a Lens

composeIso

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

compose a Optional with an Iso

asSetter

public Setter<S,A> asSetter()

view a Optional as a Setter

Overrides:

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

asTraversal

public 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()

ignored

public static <S,A> Optional<S,A> ignored()

optional

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