Packages

sealed abstract class Outcome extends Product with Serializable

Superclass for the possible outcomes of running a test.

Outcome is the result type of the withFixture methods of traits Suite and fixture.Suite, as well as their NoArgTest and OneArgTest function types. The four possible outcomes are:

  • Succeeded - indicates a test succeeded
  • Failed - indicates a test failed and contains an exception describing the failure
  • Canceled - indicates a test was canceled and contains an exception describing the cancelation
  • Pending - indicates a test was pending

Note that "ignored" does not appear as a type of Outcome, because tests are marked as ignored on the outside and skipped over as the suite executes. So an ignored test never runs, and therefore never has an outcome. By contrast, a test is determined to be pending by running the test and observing the actual outcome. If the test body completes abruptly with a TestPendingException, then the outcome was that the test was pending.

Source
Outcome.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
Canceled, Exceptional, Failed, Pending, Succeeded
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Outcome
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. 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.

  12. val isExceptional: Boolean

    Indicates whether this Outcome represents a test that either failed or was canceled, in which case this Outcome will contain an exception.

    Indicates whether this Outcome represents a test that either failed or was canceled, in which case this Outcome will contain an exception.

    returns

    true if this Outcome is an instance of either Failed or Canceled.

  13. 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.

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. 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.

  16. 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.

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def productIterator: Iterator[Any]
    Definition Classes
    Product
  21. def productPrefix: String
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toOption: Option[Throwable]

    Converts this Outcome to an Option[Throwable].

    Converts this Outcome to an Option[Throwable].

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

    returns

    a Some wrapping the contained exception if this Outcome is an instance of either Failed or Canceled.

  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped