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 any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. 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 any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  24. 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
  25. 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

  26. 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 throw an IllegalArgumentException. Therefore, only use .some when you absolutely know that the parameter is a constant and always will be. 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
    Annotations
    @throws( ... )
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toFuture: 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 NoSuchElementException 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 NoSuchElementException as its failure state

    returns

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

  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 any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (richOption: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (richOption: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: RichOption[T]

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to ArrowAssoc[RichOption[T]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (richOption: ArrowAssoc[RichOption[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: RichOption[T]

    Implicit information
    This member is added by an implicit conversion from RichOption[T] to Ensuring[RichOption[T]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (richOption: Ensuring[RichOption[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

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

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

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

Ungrouped