Package io.atlassian.fugue.optic

Class Lens<S,A>

java.lang.Object

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

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

public final class Lens<S,A>
extends PLens<S,S,A,A>

PLens with a monomorphic set function

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final PLens<S,S,A,A>	pLens

Constructor Summary

Constructors

Constructor	Description
Lens(PLens<S,S,A,A> pLens)

Method Summary

Modifier and Type	Method	Description
final Optional<S,A>	asOptional()	view a Lens as an Optional
Setter<S,A>	asSetter()	view a Lens as a Setter
final Traversal<S,A>	asTraversal()	view a Lens as a Traversal
final <C> Lens<S,C>	composeIso(Iso<A,C> other)	compose a Lens with an Iso
final <C> Lens<S,C>	composeLens(Lens<A,C> other)	compose a Lens with a Lens
final <C> Optional<S,C>	composeOptional(Optional<A,C> other)	compose a Lens with an Optional
final <C> Optional<S,C>	composePrism(Prism<A,C> other)	compose a Lens with a Prism
final <C> Setter<S,C>	composeSetter(Setter<A,C> other)	compose a Lens with a Setter
final <C> Traversal<S,C>	composeTraversal(Traversal<A,C> other)	compose a Lens with a Traversal
A	get(S s)	get the target of a PLens
static <S> Lens<S,S>	id()
static <S, A> Lens<S,A>	lens(Function<S,A> get, Function<A,Function<S,S>> set)	create a Lens using a pair of functions: one to get the target, one to set the target.
Function<S,S>	modify(Function<A,A> f)	modify polymorphically the target of a PLens using a function
<L> Function<S,Either<L,S>>	modifyEitherF(Function<A,Either<L,A>> f)	modify polymorphically the target of a PLens with an Applicative function
<C> Function<S,Function<C,S>>	modifyFunctionF(Function<A,Function<C,A>> f)	modify polymorphically the target of a PLens with an Applicative function
Function<S,Iterable<S>>	modifyIterableF(Function<A,Iterable<A>> f)	modify polymorphically the target of a PLens with an Applicative function
Function<S,Option<S>>	modifyOptionF(Function<A,Option<A>> f)	modify polymorphically the target of a PLens with an Applicative function
Function<S,Pair<S,S>>	modifyPairF(Function<A,Pair<A,A>> f)	modify polymorphically the target of a PLens with an Applicative function
Function<S,Supplier<S>>	modifySupplierF(Function<A,Supplier<A>> f)	modify polymorphically the target of a PLens with an Applicative function
Function<S,S>	set(A a)	set polymorphically the target of a PLens using a function
final <S1> Lens<Either<S,S1>,A>	sum(Lens<S1,A> other)	join two Lens with the same target

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

asFold, asGetter, composeFold, composeGetter, composeIso, composeLens, composeOptional, composePrism, composeSetter, composeTraversal, pId, pLens, sum

Methods inherited from class java.lang.Object

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

Field Details

pLens

final PLens<S,S,A,A> pLens

Constructor Details

Lens

public Lens(PLens<S,S,A,A> pLens)

Method Details

get

public A get(S s)

Description copied from class: PLens

get the target of a PLens

Specified by:

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

set

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

Description copied from class: PLens

set polymorphically the target of a PLens using a function

Specified by:

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

modifyFunctionF

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

Description copied from class: PLens

modify polymorphically the target of a PLens with an Applicative function

Specified by:

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

modifyEitherF

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

Description copied from class: PLens

modify polymorphically the target of a PLens with an Applicative function

Specified by:

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

modifyOptionF

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

Description copied from class: PLens

modify polymorphically the target of a PLens with an Applicative function

Specified by:

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

modifyIterableF

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

Description copied from class: PLens

modify polymorphically the target of a PLens with an Applicative function

Specified by:

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

modifySupplierF

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

Description copied from class: PLens

modify polymorphically the target of a PLens with an Applicative function

Specified by:

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

modifyPairF

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

Description copied from class: PLens

modify polymorphically the target of a PLens with an Applicative function

Specified by:

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

modify

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

Description copied from class: PLens

modify polymorphically the target of a PLens using a function

Specified by:

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

sum

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

join two Lens with the same target

composeSetter

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

compose a Lens with a Setter

composeTraversal

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

compose a Lens with a Traversal

composeOptional

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

compose a Lens with an Optional

composePrism

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

compose a Lens with a Prism

composeLens

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

compose a Lens with a Lens

composeIso

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

compose a Lens with an Iso

asSetter

public Setter<S,A> asSetter()

view a Lens as a Setter

Overrides:

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

asTraversal

public final Traversal<S,A> asTraversal()

view a Lens as a Traversal

Overrides:

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

asOptional

public final Optional<S,A> asOptional()

view a Lens as an Optional

Overrides:

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

id

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

lens

public static <S,
A> Lens<S,A> lens(Function<S,A> get,
 Function<A,Function<S,S>> set)

create a Lens using a pair of functions: one to get the target, one to set the target.