com.paypal.cascade.common.option

RichOption

implicit class RichOption[T] extends AnyRef

Extends an Option for side effects based on the optional value.

T

the type of the optional value

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RichOption
  2. AnyRef
  3. Any
Implicitly
  1. by Any2Option
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RichOption(option: Option[T])

    option

    the wrapped Option

Value Members

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

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

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to any2stringadd[RichOption[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RichOption[T], B)

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to ArrowAssoc[RichOption[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (RichOption[T]) ⇒ Boolean, msg: ⇒ Any): RichOption[T]

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Ensuring[RichOption[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (RichOption[T]) ⇒ Boolean): RichOption[T]

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Ensuring[RichOption[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): RichOption[T]

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Ensuring[RichOption[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): RichOption[T]

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Ensuring[RichOption[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  14. def executeIfNone(fn: ⇒ Unit): Option[T]

    If this Option is None, perform the action in fn

    If this Option is None, perform the action in fn

    fn

    the action to perform

    returns

    the wrapped Option (identity)

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to StringFormat[RichOption[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. def opt: Option[RichOption[T]]

    Wraps the given object in an Option, which resolves to None if the given object reference is null.

    Wraps the given object in an Option, which resolves to None if the given object reference is null.

    returns

    optionally, the wrapped object

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Any2Option[RichOption[T]] performed by method Any2Option in com.paypal.cascade.common.option.
    Definition Classes
    Any2Option
  24. def orThrow(t: ⇒ Throwable): T

    If this Option is None, throw the given Throwable; else, return the value inside the Option

    If this Option is None, throw the given Throwable; else, return the value inside the Option

    t

    the Throwable to potentially throw

    returns

    the value inside the wrapped Option

    Annotations
    @throws( ... )
    Exceptions thrown
    Throwable

    if the Option is None

  25. def sideEffectNone(fn: ⇒ Unit): Option[T]

    If this Option is none, perform the action in fn

    If this Option is none, perform the action in fn

    fn

    the action to perform

    returns

    the wrapped Option (identity)

  26. def sideEffectSome(fn: (T) ⇒ Unit): Option[T]

    If this Option is Some, perform the action in fn which acts on the value

    If this Option is Some, perform the action in fn which acts on the value

    fn

    the action to perform

    returns

    the wrapped Option (identity)

  27. def some: Option[RichOption[T]]

    Wraps the given object in a Some.

    Wraps the given object in a Some.

    NOTE: calling .some on a null value will return Some(null): Some[T], which is legal but broken. This behavior is equivalent to directly crafting a Some[T](null), which is also legal but broken. Overall, prefer .opt for null safety.

    returns

    the wrapped object

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Any2Option[RichOption[T]] performed by method Any2Option in com.paypal.cascade.common.option.
    Definition Classes
    Any2Option
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def toFuture(t: ⇒ Throwable): Future[T]

    Map the Option into Future success/fail states: if the Option is a Some, yield a Future with its value; if the Option is None, yield a Future with Throwable t as its failure state

    Map the Option into Future success/fail states: if the Option is a Some, yield a Future with its value; if the Option is None, yield a Future with Throwable t as its failure state

    t

    the Throwable to potentially wrap as a failure

    returns

    the Future-wrapped value of this Option, or a Future-wrapped failure Throwable

  30. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (RichOption[T], B)

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to ArrowAssoc[RichOption[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion Any2Option from RichOption[T] to Any2Option[RichOption[T]]

Inherited by implicit conversion any2stringadd from RichOption[T] to any2stringadd[RichOption[T]]

Inherited by implicit conversion StringFormat from RichOption[T] to StringFormat[RichOption[T]]

Inherited by implicit conversion Ensuring from RichOption[T] to Ensuring[RichOption[T]]

Inherited by implicit conversion ArrowAssoc from RichOption[T] to ArrowAssoc[RichOption[T]]

Ungrouped