Packages

c

scala.util

Failure

final case class Failure[+T](exception: Throwable) extends Try[T] with Product with Serializable

Source
Try.scala
Linear Supertypes
Try[T], Serializable, java.io.Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Failure
  2. Try
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Failure(exception: Throwable)

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.

    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.

    Definition Classes
    Try
    Annotations
    @deprecatedInheritance( message = ... , since = "2.12.0" )

Value Members

  1. def collect[U](pf: PartialFunction[T, U]): Try[U]

    Applies the given partial function to the value from this Success or returns this if this is a Failure.

    Applies the given partial function to the value from this Success or returns this if this is a Failure.

    Definition Classes
    FailureTry
  2. val exception: Throwable
  3. def failed: Try[Throwable]

    Inverts this Try.

    Inverts this Try. If this is a Failure, returns its exception wrapped in a Success. If this is a Success, returns a Failure containing an UnsupportedOperationException.

    Definition Classes
    FailureTry
  4. def filter(p: (T) ⇒ Boolean): Try[T]

    Converts this to a Failure if the predicate is not satisfied.

    Converts this to a Failure if the predicate is not satisfied.

    Definition Classes
    FailureTry
  5. def flatMap[U](f: (T) ⇒ Try[U]): Try[U]

    Returns the given function applied to the value from this Success or returns this if this is a Failure.

    Returns the given function applied to the value from this Success or returns this if this is a Failure.

    Definition Classes
    FailureTry
  6. def flatten[U](implicit ev: <:<[T, Try[U]]): Try[U]

    Transforms a nested Try, ie, a Try of type Try[Try[T]], into an un-nested Try, ie, a Try of type Try[T].

    Transforms a nested Try, ie, a Try of type Try[Try[T]], into an un-nested Try, ie, a Try of type Try[T].

    Definition Classes
    FailureTry
  7. def fold[U](fa: (Throwable) ⇒ U, fb: (T) ⇒ U): U

    Applies fa if this is a Failure or fb if this is a Success.

    Applies fa if this is a Failure or fb if this is a Success. If fb is initially applied and throws an exception, then fa is applied with this exception.

    fa

    the function to apply if this is a Failure

    fb

    the function to apply if this is a Success

    returns

    the results of applying the function

    Definition Classes
    FailureTry
    Example:
    1. val result: Try[Throwable, Int] = Try { string.toInt }
      log(result.fold(
        ex => "Operation failed with " + ex,
        v => "Operation produced value: " + v
      ))
  8. def foreach[U](f: (T) ⇒ U): Unit

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

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

    Note: If f throws, then this method may throw an exception.

    Definition Classes
    FailureTry
  9. def get: T

    Returns the value from this Success or throws the exception if this is a Failure.

    Returns the value from this Success or throws the exception if this is a Failure.

    Definition Classes
    FailureTry
  10. def getOrElse[U >: T](default: ⇒ U): U

    Returns the value from this Success or the given default argument if this is a Failure.

    Returns the value from this Success or the given default argument if this is a Failure.

    Note:: This will throw an exception if it is not a success and default throws an exception.

    Definition Classes
    FailureTry
  11. def isFailure: Boolean

    Returns true if the Try is a Failure, false otherwise.

    Returns true if the Try is a Failure, false otherwise.

    Definition Classes
    FailureTry
  12. def isSuccess: Boolean

    Returns true if the Try is a Success, false otherwise.

    Returns true if the Try is a Success, false otherwise.

    Definition Classes
    FailureTry
  13. def map[U](f: (T) ⇒ U): Try[U]

    Maps the given function to the value from this Success or returns this if this is a Failure.

    Maps the given function to the value from this Success or returns this if this is a Failure.

    Definition Classes
    FailureTry
  14. def orElse[U >: T](default: ⇒ Try[U]): Try[U]

    Returns this Try if it's a Success or the given default argument if this is a Failure.

    Returns this Try if it's a Success or the given default argument if this is a Failure.

    Definition Classes
    FailureTry
  15. def recover[U >: T](pf: PartialFunction[Throwable, U]): Try[U]

    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
    FailureTry
  16. def recoverWith[U >: T](pf: PartialFunction[Throwable, Try[U]]): Try[U]

    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
    FailureTry
  17. def toEither: Either[Throwable, T]

    Returns Left with Throwable if this is a Failure, otherwise returns Right with Success value.

    Returns Left with Throwable if this is a Failure, otherwise returns Right with Success value.

    Definition Classes
    FailureTry
  18. def toOption: Option[T]

    Returns None if this is a Failure or a Some containing the value if this is a Success.

    Returns None if this is a Failure or a Some containing the value if this is a Success.

    Definition Classes
    FailureTry
  19. def transform[U](s: (T) ⇒ Try[U], f: (Throwable) ⇒ Try[U]): Try[U]

    Completes this Try by applying the function f to this if this is of type Failure, or conversely, by applying s if this is a Success.

    Completes this Try by applying the function f to this if this is of type Failure, or conversely, by applying s if this is a Success.

    Definition Classes
    FailureTry
  20. final def withFilter(p: (T) ⇒ Boolean): WithFilter

    Creates a non-strict filter, which eventually converts this to a Failure if the predicate is not satisfied.

    Creates a non-strict filter, which eventually converts this to a Failure if the predicate is not satisfied.

    Note: unlike filter, withFilter does not create a new Try. Instead, it restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

    As Try is a one-element collection, this may be a bit overkill, but it's consistent with withFilter on Option and the other collections.

    p

    the predicate used to test elements.

    returns

    an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this Try which satisfy the predicate p.

    Definition Classes
    Try
    Annotations
    @inline()