diode.util

Empty

object Empty extends Pot[Nothing] with Product with Serializable

Linear Supertypes
Pot[Nothing], Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Empty
  2. Pot
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class WithFilter extends AnyRef

    We need a whole WithFilter class to honor the "doesn't create a new collection" contract even though it seems unlikely to matter much in a collection with max size 1.

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. final def ==(arg0: AnyRef): Boolean

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

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def collect[B](pf: PartialFunction[Nothing, B]): Pot[B]

    Returns a Ready containing the result of applying pf to this Pot's contained value, if this pot is nonempty and pf is defined for that value.

    Returns a Ready containing the result of applying pf to this Pot's contained value, if this pot is nonempty and pf is defined for that value. Returns Empty otherwise.

    pf

    the partial function.

    returns

    the result of applying pf to this Pot's value (if possible), or Empty.

    Definition Classes
    Pot
    Annotations
    @inline()
    Example:
    1. // Returns Ready(HTTP) because the partial function covers the case.
      Ready("http") collect {case "http" => "HTTP"}
      
      // Returns Empty because the partial function doesn't cover the case.
      Ready("ftp") collect {case "http" => "HTTP"}
      
      // Returns Empty because Empty is passed to the collect method.
      Empty collect {case value => value}
  9. final def contains[A1 >: Nothing](elem: A1): Boolean

    Tests whether the pot contains a given value as an element.

    Tests whether the pot contains a given value as an element.

    elem

    the element to test.

    returns

    true if the pot has an element that is equal (as determined by ==) to elem, false otherwise.

    Definition Classes
    Pot
    Example:
    1. // Returns true because Ready instance contains string "something" which equals "something".
      Ready("something") contains "something"
      
      // Returns false because "something" != "anything".
      Ready("something") contains "anything"
      
      // Returns false when method called on Empty.
      Empty contains "anything"
  10. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  12. def exceptionOption: Option[Throwable]

    Definition Classes
    Pot
  13. final def exists(p: (Nothing) ⇒ Boolean): Boolean

    Returns true if this pot is nonempty and the predicate $p returns true when applied to this Pot's value.

    Returns true if this pot is nonempty and the predicate $p returns true when applied to this Pot's value. Otherwise, returns false.

    p

    the predicate to test

    Definition Classes
    Pot
    Annotations
    @inline()
  14. def fail(exception: Throwable): Failed

    Definition Classes
    EmptyPot
  15. final def filter(p: (Nothing) ⇒ Boolean): Pot[Nothing]

    Returns this Pot if it is nonempty and applying the predicate $p to this Pot's value returns true.

    Returns this Pot if it is nonempty and applying the predicate $p to this Pot's value returns true. Otherwise, return Empty.

    p

    the predicate used for testing.

    Definition Classes
    Pot
    Annotations
    @inline()
  16. final def filterNot(p: (Nothing) ⇒ Boolean): Pot[Nothing]

    Returns this Pot if it is nonempty and applying the predicate $p to this Pot's value returns false.

    Returns this Pot if it is nonempty and applying the predicate $p to this Pot's value returns false. Otherwise, return Empty.

    p

    the predicate used for testing.

    Definition Classes
    Pot
    Annotations
    @inline()
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def flatMap[B](f: (Nothing) ⇒ Pot[B]): Pot[B]

    Returns the result of applying $f to this Pot's value if this Pot is nonempty.

    Returns the result of applying $f to this Pot's value if this Pot is nonempty. Returns Empty if this Pot is empty. Slightly different from map in that $f is expected to return a pot (which could be Empty).

    f

    the function to apply

    Definition Classes
    Pot
    Annotations
    @inline()
    See also

    foreach

    map

  19. def flatten[B](implicit ev: <:<[Nothing, Pot[B]]): Pot[B]

    Definition Classes
    Pot
  20. final def fold[B](ifEmpty: ⇒ B)(f: (Nothing) ⇒ B): B

    Returns the result of applying $f to this Pot's value if the Pot is nonempty.

    Returns the result of applying $f to this Pot's value if the Pot is nonempty. Otherwise, evaluates expression ifEmpty.

    ifEmpty

    the expression to evaluate if empty.

    f

    the function to apply if nonempty.

    Definition Classes
    Pot
    Annotations
    @inline()
    Note

    This is equivalent to Pot map f getOrElse ifEmpty.

  21. final def forall(p: (Nothing) ⇒ Boolean): Boolean

    Returns true if this pot is empty or the predicate $p returns true when applied to this Pot's value.

    Returns true if this pot is empty or the predicate $p returns true when applied to this Pot's value.

    p

    the predicate to test

    Definition Classes
    Pot
    Annotations
    @inline()
  22. final def foreach[U](f: (Nothing) ⇒ U): Unit

    Apply the given procedure $f to the pot's value, if it is nonempty.

    Apply the given procedure $f to the pot's value, if it is nonempty. Otherwise, do nothing.

    f

    the procedure to apply.

    Definition Classes
    Pot
    Annotations
    @inline()
    See also

    flatMap

    map

  23. def get: Nothing

    Definition Classes
    EmptyPot
  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  25. final def getOrElse[B >: Nothing](default: ⇒ B): B

    Definition Classes
    Pot
    Annotations
    @inline()
  26. def isEmpty: Boolean

    Definition Classes
    EmptyPot
  27. def isFailed: Boolean

    Definition Classes
    EmptyPot
  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. def isPending: Boolean

    Definition Classes
    EmptyPot
  30. def isReady: Boolean

    Definition Classes
    Pot
  31. def isStale: Boolean

    Definition Classes
    EmptyPot
  32. def iterator: Iterator[Nothing]

    Returns a singleton iterator returning the Pot's value if it is nonempty, or an empty iterator if the pot is empty.

    Returns a singleton iterator returning the Pot's value if it is nonempty, or an empty iterator if the pot is empty.

    Definition Classes
    Pot
  33. final def map[B](f: (Nothing) ⇒ B): Pot[B]

    Returns a Ready containing the result of applying $f to this Pot's value if this Pot is nonempty.

    Returns a Ready containing the result of applying $f to this Pot's value if this Pot is nonempty. Otherwise return Empty.

    f

    the function to apply

    Definition Classes
    Pot
    Annotations
    @inline()
    Note

    This is similar to flatMap except here, $f does not need to wrap its result in a pot.

    See also

    foreach

    flatMap

  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. final def nonEmpty: Boolean

    Returns false if the pot is Empty, true otherwise.

    Returns false if the pot is Empty, true otherwise.

    Definition Classes
    Pot
    Note

    Implemented here to avoid the implicit conversion to Iterable.

  36. final def notify(): Unit

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

    Definition Classes
    AnyRef
  38. final def orElse[B >: Nothing](alternative: ⇒ Pot[B]): Pot[B]

    Returns this Pot if it is nonempty, otherwise return the result of evaluating alternative.

    Returns this Pot if it is nonempty, otherwise return the result of evaluating alternative.

    alternative

    the alternative expression.

    Definition Classes
    Pot
    Annotations
    @inline()
  39. def pending(policy: RetryPolicy): Pending

    Definition Classes
    EmptyPot
  40. def ready[B >: Nothing](value: B): Pot[B]

    Definition Classes
    Pot
  41. def recover[B >: Nothing](f: PartialFunction[Throwable, B]): Pot[B]

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success.

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success. This is like map for the exception.

    Definition Classes
    Pot
  42. def recoverWith[B >: Nothing](f: PartialFunction[Throwable, Pot[B]]): Pot[B]

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success.

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success. This is like flatMap for the exception.

    Definition Classes
    Pot
  43. def retriesLeft: Int

  44. def retry(policy: RetryPolicy): Nothing

    Definition Classes
    EmptyPot
  45. def retryPolicy: None.type

    Definition Classes
    EmptyPot
  46. def state: PotEmpty.type

    Definition Classes
    EmptyPot
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  48. final def toLeft[X](right: ⇒ X): Product with Serializable with Either[Nothing, X]

    Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this Pot's value if this Pot is nonempty.

    Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this Pot's value if this Pot is nonempty.

    right

    the expression to evaluate and return if this is empty

    Definition Classes
    Pot
    Annotations
    @inline()
    See also

    toRight

  49. def toList: List[Nothing]

    Returns a singleton list containing the Pot's value if it is nonempty, or the empty list if the Pot is empty.

    Returns a singleton list containing the Pot's value if it is nonempty, or the empty list if the Pot is empty.

    Definition Classes
    Pot
  50. def toOption: Option[Nothing]

    Returns None if this is empty or a Some containing the value otherwise.

    Returns None if this is empty or a Some containing the value otherwise.

    Definition Classes
    Pot
    Annotations
    @inline()
  51. final def toRight[X](left: ⇒ X): Product with Serializable with Either[X, Nothing]

    Returns a scala.util.Left containing the given argument left if this Pot is empty, or a scala.util.Right containing this Pot's value if this is nonempty.

    Returns a scala.util.Left containing the given argument left if this Pot is empty, or a scala.util.Right containing this Pot's value if this is nonempty.

    left

    the expression to evaluate and return if this is empty

    Definition Classes
    Pot
    Annotations
    @inline()
    See also

    toLeft

  52. def toTry: Try[Nothing]

    Returns Failure if this has failed or a Success containing the value otherwise.

    Returns Failure if this has failed or a Success containing the value otherwise.

    Definition Classes
    Pot
  53. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def withFilter(p: (Nothing) ⇒ Boolean): WithFilter

    Necessary to keep Pot from being implicitly converted to scala.collection.Iterable in for comprehensions.

    Necessary to keep Pot from being implicitly converted to scala.collection.Iterable in for comprehensions.

    Definition Classes
    Pot
    Annotations
    @inline()

Inherited from Pot[Nothing]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped