org.scalatest

Args

case class Args (reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker, chosenStyles: Set[String], runTestInNewInstance: Boolean, distributedTestSorter: Option[DistributedTestSorter], distributedSuiteSorter: Option[DistributedSuiteSorter]) extends Product with Serializable

Arguments bundle passed to four of ScalaTest's lifecycle methods: run, runNestedSuites, runTests, and runTest.

The signatures of these methods, defined in trait Suite, are:

def run(testName: Option[String], args: Args)
def runNestedSuites(args: Args)
def runTests(testName: Option[String], args: Args)
def runTess(testName: String, args: Args)

The purpose of bundling these arguments into an Args object instead of passing them in individually is to make the signature of these four lifecycle methods easier to read, and write, and remember, to make the methods more pleasant to override in user code.

reporter

the Reporter to which results will be reported

stopper

the Stopper that will be consulted to determine whether to stop execution early.

filter

a Filter with which to filter tests based on their tags

configMap

a Map of key-value pairs that can be used by the executing Suite of tests.

distributor

an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.

tracker

a Tracker tracking Ordinals being fired by the current thread.

chosenStyles

a (possibly empty) Set of Strings specifying the run's chosen styles

runTestInNewInstance

a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.

distributedTestSorter

an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete

distributedSuiteSorter

an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Args
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Args (reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker, chosenStyles: Set[String], runTestInNewInstance: Boolean, distributedTestSorter: Option[DistributedTestSorter], distributedSuiteSorter: Option[DistributedSuiteSorter])

    reporter

    the Reporter to which results will be reported

    stopper

    the Stopper that will be consulted to determine whether to stop execution early.

    filter

    a Filter with which to filter tests based on their tags

    configMap

    a Map of key-value pairs that can be used by the executing Suite of tests.

    distributor

    an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.

    tracker

    a Tracker tracking Ordinals being fired by the current thread.

    chosenStyles

    a (possibly empty) Set of Strings specifying the run's chosen styles

    runTestInNewInstance

    a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.

    distributedTestSorter

    an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete

    distributedSuiteSorter

    an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def canEqual (arg0: Any): Boolean

    Definition Classes
    Args → Equals

  8. val chosenStyles : Set[String]

    a (possibly empty) Set of Strings specifying the run's chosen styles

    a (possibly empty) Set of Strings specifying the run's chosen styles

  9. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  10. val configMap : Map[String, Any]

    a Map of key-value pairs that can be used by the executing Suite of tests.

  11. val distributedSuiteSorter : Option[DistributedSuiteSorter]

    an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel

    an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel

  12. val distributedTestSorter : Option[DistributedTestSorter]

    an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete

    an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete

  13. val distributor : Option[Distributor]

    an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads.

    an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.

  14. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  15. def equals (arg0: Any): Boolean

    Definition Classes
    Args → Equals → AnyRef → Any

  16. val filter : Filter

    a Filter with which to filter tests based on their tags

  17. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  18. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef

  19. def hashCode (): Int

    Definition Classes
    Args → AnyRef → Any

  20. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  21. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  22. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  23. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  24. def productArity : Int

    Definition Classes
    Args → Product

  25. def productElement (arg0: Int): Any

    Definition Classes
    Args → Product

  26. def productIterator : Iterator[Any]

    Definition Classes
    Product

  27. def productPrefix : String

    Definition Classes
    Args → Product

  28. val reporter : Reporter

    the Reporter to which results will be reported

  29. val runTestInNewInstance : Boolean

    a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.

    a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.

  30. val stopper : Stopper

    the Stopper that will be consulted to determine whether to stop execution early.

  31. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  32. def toString (): String

    Definition Classes
    Args → AnyRef → Any

  33. val tracker : Tracker

    a Tracker tracking Ordinals being fired by the current thread.

  34. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  35. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  36. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  37. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any