sbt.testing

TaskDef

Related Doc: package testing

final class TaskDef extends Serializable

A bundle of information used to request a Task from a test framework.

An array of TaskDef is passed to Runner's tasks method, which returns an array of Tasks. Each returned task, when executed, will run tests and suites determined by the test class name, fingerprints, "explicitly specified" field, and selectors of one of the passed TaskDefs.

The "Explicitly specified" field means the user supplied a complete fully qualified test name, such as with the command:

> test-only com.mycompany.myproject.WholeNameSpec

as opposed to commands like:

> test-only *WholeNameSpec

or simply:

> test

The explicitlySpecified field will be true for in the first case, and false in the last two cases, because only in the first case was the fully qualified test class name completely specified by the user. The test framework can use this information to decide whether to ignore an annotation requesting a class not be discovered.

The fingerprint parameter indicates how the test suite was identified as a test suite. This tasks method may be called with TaskDefs containing the same value for testClassName but different fingerprints. For example, if both a class and its companion object were test classes, the tasks method could be passed an array containing TaskDefs with the same name but with a different value for fingerprint.isModule.

A test framework may "reject" a requested task by returning no Task for that TaskDef.

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TaskDef
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TaskDef(_fullyQualifiedName: String, _fingerprint: Fingerprint, _explicitlySpecified: Boolean, _selectors: Array[Selector])

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
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. def equals(that: Any): Boolean

    Definition Classes
    TaskDef → AnyRef → Any

  8. def explicitlySpecified(): Boolean

    Indicates whether or not the test class requested by this TaskDef was "explicitly specified."

    Indicates whether or not the test class requested by this TaskDef was "explicitly specified."

    For more information on what explicitly specified means, see the main documentation for this class.

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. def fingerprint(): Fingerprint

    The fingerprint that the test class requested by this TaskDef matches.

    The fingerprint that the test class requested by this TaskDef matches.

  11. def fullyQualifiedName(): String

    The fully qualified name of the test class requested by this TaskDef.

    The fully qualified name of the test class requested by this TaskDef.

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    TaskDef → AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def selectors(): Array[Selector]

    One to many selectors describing the nature of the Task requested by this TaskDef.

    One to many selectors describing the nature of the Task requested by this TaskDef.

    A Selector can indicate a direct, such as command-line, request from the user or a "rerun" of previously run tests. In the latter case, the Selectors would be taken from those passed in events of a previous run or runs.

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    TaskDef → AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped