abstract class POptional[S, T, A, B] extends Serializable
A POptional can be seen as a pair of functions:
getOrModify: S => Either[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
- Alphabetic
- By Inheritance
- POptional
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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): Either[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
all(p: (A) ⇒ Boolean): (S) ⇒ Boolean
check if there is no target or the target satisfies the predicate
check if there is no target or the target satisfies the predicate
- Annotations
- @inline()
- final def asFold: Fold[S, A]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def asSetter: PSetter[S, T, A, B]
-
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[Either[S, S1], Either[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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- 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]
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
-
final
def
exist(p: (A) ⇒ Boolean): (S) ⇒ Boolean
check if there is a target and it satisfies the predicate
check if there is a target and it satisfies the predicate
- Annotations
- @inline()
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
find(p: (A) ⇒ Boolean): (S) ⇒ Option[A]
find if the target satisfies the predicate
find if the target satisfies the predicate
- Annotations
- @inline()
-
final
def
first[C]: POptional[(S, C), (T, C), (A, C), (B, C)]
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isEmpty(s: S): Boolean
check if there is no target
check if there is no target
- Annotations
- @inline()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
modifyOption(f: (A) ⇒ B): (S) ⇒ Option[T]
modify polymorphically the target of a POptional with a function.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
nonEmpty(s: S): Boolean
check if there is a target
check if there is a target
- Annotations
- @inline()
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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.
-
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( ... ) @native()