org.scalatest.DoNotDiscover Maven / Gradle / Ivy
/*
* Copyright 2001-2013 Artima, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.scalatest;
import java.lang.annotation.*;
/**
* Annotation used to indicate that an otherwise discoverable test class should not be discovered.
*
*
* 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.
*
*
*
* ScalaTest will discover any class that either extends Suite and has a public, no-arg constructor, or is annotated with
* a valid WrapWith annotation. If you wish to prevent a class from being discovered, simply annotate it
* with DoNotDiscover, like this:
*
*
*
* import org.scalatest._
*
* @DoNotDiscover
* class SetSpec extends FlatSpec {
*
* "An empty Set" should "have size 0" in {
* assert(Set.empty.size === 0)
* }
*
* it should "produce NoSuchElementException when head is invoked" in {
* intercept[NoSuchElementException] {
* Set.empty.head
* }
* }
* }
*
*
*
* ScalaTest will run classes annotated with DoNotDiscover if asked to explicitly, it just won't discover them.
*
*
*
* Note that because reflection is not supported on Scala.js, this annotation will only work on the JVM, not on Scala.js.
*
*/
@TagAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface DoNotDiscover {
}