Lens (core 4.4 API)

java.lang.Object
- fj.data.optic.PLens<S,S,A,A>
- - fj.data.optic.Lens<S,A>

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

PLens with a monomorphic set function

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<S,A>`	`asOptional()` view a `Lens` as an `Optional`
`Setter<S,A>`	`asSetter()` view a `Lens` as a `Setter`
`Traversal<S,A>`	`asTraversal()` view a `Lens` as a `Traversal`
`<C> Lens<S,C>`	`composeIso(Iso<A,C> other)` compose a `Lens` with an `Iso`
`<C> Lens<S,C>`	`composeLens(Lens<A,C> other)` compose a `Lens` with a `Lens`
`<C> Optional<S,C>`	`composeOptional(Optional<A,C> other)` compose a `Lens` with an `Optional`
`<C> Optional<S,C>`	`composePrism(Prism<A,C> other)` compose a `Lens` with a `Prism`
`<C> Setter<S,C>`	`composeSetter(Setter<A,C> other)` compose a `Lens` with a `Setter`
`<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(F<S,A> get, F<A,F<S,S>> set)` create a `Lens` using a pair of functions: one to get the target, one to set the target.
`F<S,S>`	`modify(F<A,A> f)` modify polymorphically the target of a `PLens` using a function
`<L> F<S,Either<L,S>>`	`modifyEitherF(F<A,Either<L,A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`<C> F<S,F<C,S>>`	`modifyFunctionF(F<A,F<C,A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,IO<S>>`	`modifyIOF(F<A,IO<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,List<S>>`	`modifyListF(F<A,List<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,Option<S>>`	`modifyOptionF(F<A,Option<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,P1<S>>`	`modifyP1F(F<A,P1<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,Promise<S>>`	`modifyPromiseF(F<A,Promise<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,Stream<S>>`	`modifyStreamF(F<A,Stream<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,Trampoline<S>>`	`modifyTrampolineF(F<A,Trampoline<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,V2<S>>`	`modifyV2F(F<A,V2<A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`<E> F<S,Validation<E,S>>`	`modifyValidationF(F<A,Validation<E,A>> f)` modify polymorphically the target of a `PLens` with an Applicative function
`F<S,S>`	`set(A a)` set polymorphically the target of a `PLens` using a function
`<S1> Lens<Either<S,S1>,A>`	`sum(Lens<S1,A> other)` join two `Lens` with the same target

Methods inherited from class fj.data.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

- Constructor Detail
  - Lens
```
public Lens(PLens<S,S,A,A> pLens)
```
- Method Detail
  - 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 F<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> F<S,F<C,S>> modifyFunctionF(F<A,F<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> F<S,Either<L,S>> modifyEitherF(F<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>
  - modifyIOF
```
public F<S,IO<S>> modifyIOF(F<A,IO<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyIOF in class PLens<S,S,A,A>
  - modifyTrampolineF
```
public F<S,Trampoline<S>> modifyTrampolineF(F<A,Trampoline<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyTrampolineF in class PLens<S,S,A,A>
  - modifyPromiseF
```
public F<S,Promise<S>> modifyPromiseF(F<A,Promise<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyPromiseF in class PLens<S,S,A,A>
  - modifyListF
```
public F<S,List<S>> modifyListF(F<A,List<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyListF in class PLens<S,S,A,A>
  - modifyOptionF
```
public F<S,Option<S>> modifyOptionF(F<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>
  - modifyStreamF
```
public F<S,Stream<S>> modifyStreamF(F<A,Stream<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyStreamF in class PLens<S,S,A,A>
  - modifyP1F
```
public F<S,P1<S>> modifyP1F(F<A,P1<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyP1F in class PLens<S,S,A,A>
  - modifyValidationF
```
public <E> F<S,Validation<E,S>> modifyValidationF(F<A,Validation<E,A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyValidationF in class PLens<S,S,A,A>
  - modifyV2F
```
public F<S,V2<S>> modifyV2F(F<A,V2<A>> f)
```
    Description copied from class: PLens
    
    modify polymorphically the target of a PLens with an Applicative function
    
    Specified by:
    
    modifyV2F in class PLens<S,S,A,A>
  - modify
```
public F<S,S> modify(F<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 final <S> Lens<S,S> id()
```
  - lens
```
public static <S,A> Lens<S,A> lens(F<S,A> get,
                                   F<A,F<S,S>> set)
```
    create a Lens using a pair of functions: one to get the target, one to set the target.

Class Lens<S,A>

Constructor Summary

Method Summary

Methods inherited from class fj.data.optic.PLens

Methods inherited from class java.lang.Object

Constructor Detail

Lens

Method Detail

get

set

modifyFunctionF

modifyEitherF

modifyIOF

modifyTrampolineF

modifyPromiseF

modifyListF

modifyOptionF

modifyStreamF

modifyP1F

modifyValidationF

modifyV2F

modify

sum

composeSetter

composeTraversal

composeOptional

composePrism

composeLens

composeIso

asSetter

asTraversal

asOptional

id

lens