Packages

sealed abstract class Exceptional extends Outcome

Superclass for the two outcomes of running a test that contain an exception: Failed and Canceled.

This class provides a toOption method that returns a Some wrapping the contained exception, and an isExceptional field with the value true. It's companion object provides an extractor that enables patterns that match a test that either failed or canceled, as in:

outcome match {
  case Exceptional(ex) => // handle failed or canceled case
  case _ => // handle succeeded, pending, or omitted case
}

Source
Outcome.scala
Linear Supertypes
Outcome, Serializable, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
Canceled, Failed
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Exceptional
  2. Outcome
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def productArity: Int
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  4. abstract def toSucceeded: Succeeded.type

    Converts this Outcome to a Succeeded.

    Converts this Outcome to a Succeeded.

    When this Outcome instance is not Succeeded, it behaves as followed:

    • Failed(ex) - throws ex
    • Canceled(tce) - throws tce
    • Pending - throws TestPendingException
    returns

    Succeeded if this Outcome instance is a Succeeded.

    Definition Classes
    Outcome

Concrete Value Members

  1. val isCanceled: Boolean

    Indicates whether this Outcome represents a test that was canceled.

    Indicates whether this Outcome represents a test that was canceled.

    This class's implementation of this method always returns false.

    returns

    true if this Outcome is an instance of Canceled.

    Definition Classes
    Outcome
  2. val isExceptional: Boolean

    Indicates that this Outcome represents a test that either failed or was canceled.

    Indicates that this Outcome represents a test that either failed or was canceled.

    returns

    true

    Definition Classes
    Exceptional → Outcome
  3. val isFailed: Boolean

    Indicates whether this Outcome represents a test that failed.

    Indicates whether this Outcome represents a test that failed.

    This class's implementation of this method always returns false.

    returns

    true if this Outcome is an instance of Failed.

    Definition Classes
    Outcome
  4. val isPending: Boolean

    Indicates whether this Outcome represents a test that was pending.

    Indicates whether this Outcome represents a test that was pending.

    This class's implementation of this method always returns false.

    returns

    true if this Outcome is an instance of Pending.

    Definition Classes
    Outcome
  5. val isSucceeded: Boolean

    Indicates whether this Outcome represents a test that succeeded.

    Indicates whether this Outcome represents a test that succeeded.

    This class's implementation of this method always returns false.

    returns

    true if this Outcome is an instance of Succeeded.

    Definition Classes
    Outcome
  6. def productIterator: Iterator[Any]
    Definition Classes
    Product
  7. def productPrefix: String
    Definition Classes
    Product
  8. def toOption: Option[Throwable]

    Converts this Exceptional to a Some that wraps the contained exception.

    Converts this Exceptional to a Some that wraps the contained exception.

    returns

    A Some wrapping the exception contained in this Exceptional.

    Definition Classes
    Exceptional → Outcome