Class/Object

org.scalatest

Exceptional

Related Docs: object Exceptional | package scalatest

Permalink

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

    Permalink
    Definition Classes
    Equals
  2. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product
  4. abstract def toSucceeded: Succeeded.type

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. val isCanceled: Boolean

    Permalink

    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
  12. val isExceptional: Boolean

    Permalink

    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
    ExceptionalOutcome
  13. val isFailed: Boolean

    Permalink

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

    Permalink
    Definition Classes
    Any
  15. val isPending: Boolean

    Permalink

    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
  16. val isSucceeded: Boolean

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  21. def productPrefix: String

    Permalink
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toOption: Option[Throwable]

    Permalink

    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
    ExceptionalOutcome
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Outcome

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped