POptional

A POptional can be seen as a pair of functions:

getOrModify: S => T \/ A
set : (B, S) => T

A POptional could also be defined as a weaker PLens and weaker PPrism

POptional stands for Polymorphic Optional as it set and modify methods change a type A to B and S to T. Optional is a type alias for POptional restricted to monomorphic updates:

type Optional[S, A] = POptional[S, S, A, A]

S: the source of a POptional
T: the modified source of a POptional
A: the target of a POptional
B: the modified target of a POptional

Self Type: POptional[S, T, A, B]
See also: monocle.law.OptionalLaws

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Instance Constructors

new POptional()

Abstract Value Members

abstract def getOption(s: S): Option[A]

get the target of a POptional or nothing if there is no target
abstract def getOrModify(s: S): \/[T, A]

get the target of a POptional or return the original value while allowing the type to change if it does not match
abstract def modify(f: (A) ⇒ B): (S) ⇒ T

modify polymorphically the target of a POptional with a function
abstract def modifyF[F[_]](f: (A) ⇒ F[B])(s: S)(implicit arg0: Applicative[F]): F[T]

modify polymorphically the target of a POptional with an Applicative function
abstract def set(b: B): (S) ⇒ T

get the modified source of a POptional

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

alias to composeIso
alias to composeIso

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

alias to composePrism
alias to composePrism

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

alias to composeLens
alias to composeLens

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

alias to composeTraversal
alias to composeTraversal

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

alias to composeOptional
alias to composeOptional

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

view a POptional as a Fold
view a POptional as a Fold

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

Definition Classes
Any
final def asSetter: PSetter[S, T, A, B]

view a POptional as a PSetter
view a POptional as a PSetter

Annotations
@inline()
final def asTraversal: PTraversal[S, T, A, B]

view a POptional as a PTraversal
view a POptional as a PTraversal

Annotations
@inline()
final def choice[S1, T1](other: POptional[S1, T1, A, B]): POptional[\/[S, S1], \/[T, T1], A, B]

join two POptional with the same target
join two POptional with the same target

Annotations
@inline()
def clone(): AnyRef

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

compose a POptional with a Fold
compose a POptional with a Fold

Annotations
@inline()
final def composeGetter[C](other: Getter[A, C]): Fold[S, C]

compose a POptional with a Getter
compose a POptional with a Getter

Annotations
@inline()
final def composeIso[C, D](other: PIso[A, B, C, D]): POptional[S, T, C, D]

compose a POptional with a PIso
compose a POptional with a PIso

Annotations
@inline()
final def composeLens[C, D](other: PLens[A, B, C, D]): POptional[S, T, C, D]

compose a POptional with a PLens
compose a POptional with a PLens

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

compose a POptional with a POptional
compose a POptional with a POptional

Annotations
@inline()
final def composePrism[C, D](other: PPrism[A, B, C, D]): POptional[S, T, C, D]

compose a POptional with a PPrism
compose a POptional with a PPrism

Annotations
@inline()
final def composeSetter[C, D](other: PSetter[A, B, C, D]): PSetter[S, T, C, D]

compose a POptional with a PSetter
compose a POptional with a PSetter

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

compose a POptional with a PTraversal
compose a POptional with a PTraversal

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def first[C]: POptional[(S, C), (T, C), (A, C), (B, C)]

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def isMatching(s: S): Boolean

check if a POptional has a target
check if a POptional has a target

Annotations
@inline()
final def modifyOption(f: (A) ⇒ B): (S) ⇒ Option[T]

modify polymorphically the target of a POptional with a function.
modify polymorphically the target of a POptional with a function. return empty if the POptional is not matching

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def second[C]: POptional[(C, S), (C, T), (C, A), (C, B)]

Annotations
@inline()
final def setOption(b: B): (S) ⇒ Option[T]

set polymorphically the target of a POptional with a value.
set polymorphically the target of a POptional with a value. return empty if the POptional is not matching

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

final def getMaybe(s: S): Maybe[A]

Annotations
@deprecated @inline()
Deprecated
(Since version 1.1.0) use getOption
final def modifyMaybe(f: (A) ⇒ B): (S) ⇒ Maybe[T]

Annotations
@deprecated @inline()
Deprecated
(Since version 1.1.0) use modifyOption
final def setMaybe(b: B): (S) ⇒ Maybe[T]

Annotations
@deprecated @inline()
Deprecated
(Since version 1.1.0) use setOption
final def sum[S1, T1](other: POptional[S1, T1, A, B]): POptional[\/[S, S1], \/[T, T1], A, B]

Annotations
@deprecated @inline()
Deprecated
(Since version 1.2.0) use choice

Related Docs: object POptional | package monocle

abstract class POptional[S, T, A, B] extends Serializable

Instance Constructors

new POptional()

Abstract Value Members

abstract def getOption(s: S): Option[A]

abstract def getOrModify(s: S): \/[T, A]

abstract def modify(f: (A) ⇒ B): (S) ⇒ T

abstract def modifyF[F[_]](f: (A) ⇒ F[B])(s: S)(implicit arg0: Applicative[F]): F[T]

abstract def set(b: B): (S) ⇒ T

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def ^<->[C, D](other: PIso[A, B, C, D]): POptional[S, T, C, D]

final def ^<-?[C, D](other: PPrism[A, B, C, D]): POptional[S, T, C, D]

final def ^|->[C, D](other: PLens[A, B, C, D]): POptional[S, T, C, D]

final def ^|->>[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]

final def ^|-?[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

final def asFold: Fold[S, A]

final def asInstanceOf[T0]: T0

final def asSetter: PSetter[S, T, A, B]

final def asTraversal: PTraversal[S, T, A, B]

final def choice[S1, T1](other: POptional[S1, T1, A, B]): POptional[\/[S, S1], \/[T, T1], A, B]

def clone(): AnyRef

final def composeFold[C](other: Fold[A, C]): Fold[S, C]

final def composeGetter[C](other: Getter[A, C]): Fold[S, C]

final def composeIso[C, D](other: PIso[A, B, C, D]): POptional[S, T, C, D]

final def composeLens[C, D](other: PLens[A, B, C, D]): POptional[S, T, C, D]

final def composeOptional[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

final def composePrism[C, D](other: PPrism[A, B, C, D]): POptional[S, T, C, D]

final def composeSetter[C, D](other: PSetter[A, B, C, D]): PSetter[S, T, C, D]

final def composeTraversal[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def first[C]: POptional[(S, C), (T, C), (A, C), (B, C)]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def isMatching(s: S): Boolean

final def modifyOption(f: (A) ⇒ B): (S) ⇒ Option[T]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def second[C]: POptional[(C, S), (C, T), (C, A), (C, B)]

final def setOption(b: B): (S) ⇒ Option[T]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

final def getMaybe(s: S): Maybe[A]

final def modifyMaybe(f: (A) ⇒ B): (S) ⇒ Maybe[T]

final def setMaybe(b: B): (S) ⇒ Maybe[T]

final def sum[S1, T1](other: POptional[S1, T1, A, B]): POptional[\/[S, S1], \/[T, T1], A, B]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped