Class/Object

monocle

Getter

Related Docs: object Getter | package monocle

Permalink

abstract class Getter[S, A] extends Serializable

A Getter can be seen as a glorified get method between a type S and a type A.

A Getter is also a valid Fold

S

the source of a Getter

A

the target of a Getter

Self Type
Getter[S, A]
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Getter
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Getter()

    Permalink

Abstract Value Members

  1. abstract def get(s: S): A

    Permalink

    get the target of a Getter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def ^<->[B, C, D](other: PIso[A, B, C, D]): Getter[S, C]

    Permalink

    alias to composeIso

    alias to composeIso

    Annotations
    @inline()
  5. final def ^<-?[B, C, D](other: PPrism[A, B, C, D]): Fold[S, C]

    Permalink

    alias to composePrism

    alias to composePrism

    Annotations
    @inline()
  6. final def ^|->[B, C, D](other: PLens[A, B, C, D]): Getter[S, C]

    Permalink

    alias to composeLens

    alias to composeLens

    Annotations
    @inline()
  7. final def ^|->>[B, C, D](other: PTraversal[A, B, C, D]): Fold[S, C]

    Permalink

    alias to composeTraversal

    alias to composeTraversal

    Annotations
    @inline()
  8. final def ^|-?[B, C, D](other: POptional[A, B, C, D]): Fold[S, C]

    Permalink

    alias to composeOptional

    alias to composeOptional

    Annotations
    @inline()
  9. final def asFold: Fold[S, A]

    Permalink

    view a Getter with a Fold

    view a Getter with a Fold

    Annotations
    @inline()
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. final def choice[S1](other: Getter[S1, A]): Getter[\/[S, S1], A]

    Permalink

    join two Getter with the same target

    join two Getter with the same target

    Annotations
    @inline()
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def composeFold[B](other: Fold[A, B]): Fold[S, B]

    Permalink

    compose a Getter with a Fold

    compose a Getter with a Fold

    Annotations
    @inline()
  14. final def composeGetter[B](other: Getter[A, B]): Getter[S, B]

    Permalink

    compose a Getter with a Getter

    compose a Getter with a Getter

    Annotations
    @inline()
  15. final def composeIso[B, C, D](other: PIso[A, B, C, D]): Getter[S, C]

    Permalink

    compose a Getter with a PIso

    compose a Getter with a PIso

    Annotations
    @inline()
  16. final def composeLens[B, C, D](other: PLens[A, B, C, D]): Getter[S, C]

    Permalink

    compose a Getter with a PLens

    compose a Getter with a PLens

    Annotations
    @inline()
  17. final def composeOptional[B, C, D](other: POptional[A, B, C, D]): Fold[S, C]

    Permalink

    compose a Getter with a POptional

    compose a Getter with a POptional

    Annotations
    @inline()
  18. final def composePrism[B, C, D](other: PPrism[A, B, C, D]): Fold[S, C]

    Permalink

    compose a Getter with a PPrism

    compose a Getter with a PPrism

    Annotations
    @inline()
  19. final def composeTraversal[B, C, D](other: PTraversal[A, B, C, D]): Fold[S, C]

    Permalink

    compose a Getter with a PTraversal

    compose a Getter with a PTraversal

    Annotations
    @inline()
  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def exist(p: (A) ⇒ Boolean): (S) ⇒ Boolean

    Permalink

    check if the target satisfies the predicate

    check if the target satisfies the predicate

    Annotations
    @inline()
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def find(p: (A) ⇒ Boolean): (S) ⇒ Option[A]

    Permalink

    find if the target satisfies the predicate

    find if the target satisfies the predicate

    Annotations
    @inline()
  25. final def first[B]: Getter[(S, B), (A, B)]

    Permalink
    Annotations
    @inline()
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. final def left[C]: Getter[\/[S, C], \/[A, C]]

    Permalink
    Annotations
    @inline()
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def right[C]: Getter[\/[C, S], \/[C, A]]

    Permalink
    Annotations
    @inline()
  34. final def second[B]: Getter[(B, S), (B, A)]

    Permalink
    Annotations
    @inline()
  35. final def split[S1, A1](other: Getter[S1, A1]): Getter[(S, S1), (A, A1)]

    Permalink

    pair two disjoint Getter

    pair two disjoint Getter

    Annotations
    @inline()
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def zip[A1](other: Getter[S, A1]): Getter[S, (A, A1)]

    Permalink
    Annotations
    @inline()

Deprecated Value Members

  1. final def product[S1, A1](other: Getter[S1, A1]): Getter[(S, S1), (A, A1)]

    Permalink
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 1.2.0) use split

  2. final def sum[S1](other: Getter[S1, A]): Getter[\/[S, S1], A]

    Permalink
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 1.2.0) use choice

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped