Package com.github.tonivade.purefun.optics

Class Optional<S,A>

java.lang.Object

com.github.tonivade.purefun.optics.Optional<S,A>

public final class Optional<S,A>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final POptional<S,S,A,A>	delegate

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
<B> Optional<S,B>	compose(Iso<A,B> other)
<B> Optional<S,B>	compose(Lens<A,B> other)
<B> Optional<S,B>	compose(Optional<A,B> other)
<B> Optional<S,B>	compose(Prism<A,B> other)
Option<A>	getOption(S target)
Either<S,A>	getOrModify(S target)
Operator1<S>	lift(Operator1<A> mapper)
S	modify(S target, Operator1<A> mapper)
Option<S>	modifyOption(S target, Operator1<A> mapper)
static <S, A> Optional<S,A>	of(Function2<S,A,S> set, Function1<S,Option<A>> getOption)
Function1<A,S>	set(S target)
S	set(S target, A value)

Methods inherited from class java.lang.Object

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

Field Details

delegate

private final POptional<S,S,A,A> delegate

Constructor Details

Optional

Optional(POptional<S,S,A,A> delegate)

Method Details

of

public static <S,
A> Optional<S,A> of(Function2<S,A,S> set,
 Function1<S,Option<A>> getOption)

set

public Function1<A,S> set(S target)

set

public S set(S target,
 A value)

getOrModify

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

getOption

public Option<A> getOption(S target)

lift

public Operator1<S> lift(Operator1<A> mapper)

modify

public S modify(S target,
 Operator1<A> mapper)

modifyOption

public Option<S> modifyOption(S target,
 Operator1<A> mapper)

compose

public <B> Optional<S,B> compose(Optional<A,B> other)

compose

public <B> Optional<S,B> compose(Iso<A,B> other)

compose

public <B> Optional<S,B> compose(Prism<A,B> other)

compose

public <B> Optional<S,B> compose(Lens<A,B> other)