Trait

org.scalatest

WrapWith

Related Doc: package scalatest

Permalink

trait WrapWith extends Annotation

Annotation to associate a wrapper suite with a non-Suite class, so it can be run via ScalaTest.

Note: This is actually an annotation defined in Java, not a Scala trait. It must be defined in Java instead of Scala so it will be accessible at runtime. It has been inserted into Scaladoc by pretending it is a trait.

A class will be considered annotated with WrapWith if it is annotated directly or one of its superclasses (but not supertraits) are annotated with WrapWith. The wrapper suite must have a public, one-arg constructor that takes a Class instance whose type parameter is compatible with the class to wrap: i.e., the class being annotated with WrapWith. ScalaTest will load the class to wrap and construct a new instance of the wrapper suite, passing in the Class instance for the class to wrap. Here's an example:

import org.scalacheck.Properties

@WrapWith(classOf[ScalaCheckPropertiesSpec])
class StringSpecification extends Properties("String") {
  // ...
}

The ScalaCheckPropertiesSpec would need to have a public, no-arg constructor that accepts subclasses of org.scalacheck.Properties:

import org.scalacheck.Properties
import org.scalatest.Suite

class ScalaCheckPropertiesSpec(clazz: Class[_ <: Properties]) extends Suite {
  // ...
}

Source
WrapWith.scala
Linear Supertypes
Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WrapWith
  2. Annotation
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def annotationType(): Class[_ <: Annotation]

    Permalink
    Definition Classes
    Annotation
  2. abstract def value(): Class[_ <: Suite]

    Permalink

    The wrapper suite.

    The wrapper suite.

    returns

    a wrapper suite class, which must have a constructor that takes a single Class to run