ScalaTest 1.1
org.scalatest

class Filter
[source: org/scalatest/Filter.scala]
final class Filter(val tagsToInclude : scala.Option[scala.collection.immutable.Set[java.lang.String]], val tagsToExclude : scala.collection.immutable.Set[java.lang.String])
extends (scala.collection.immutable.Set[java.lang.String], scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) => scala.List[(java.lang.String, Boolean)]
Filter whose apply method determines which of the passed tests to run and ignore based on tags to include and exclude passed as as class parameters.

This class handles the org.scalatest.Ignore tag specially, in that its apply method indicates which tests should be ignored based on whether they are tagged with org.scalatest.Ignore. If "org.scalatest.Ignore" is not passed in the tagsToExclude set, it will be implicitly added. However, if the tagsToInclude option is defined, and the contained set does not include "org.scalatest.Ignore", then only those tests that are both tagged with org.scalatest.Ignore and at least one of the tags in the tagsToInclude set will be included in the result of apply and marked as ignored (so long as the test is not also marked with a tag other than org.scalatest.Ignore that is a member of the tagsToExclude set. For example, if SlowAsMolasses is a member of the tagsToInclude set and a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolasses appears in the tagsToExclude set, the SlowAsMolasses tag will "overpower" the org.scalatest.Ignore tag, and the test will be filtered out entirely rather than being ignored.

Parameters
tagsToInclude - an optional Set of String tag names to include (i.e., not filter out) when filtering tests
tagsToExclude - a Set of String tag names to exclude (i.e., filter out) when filtering tests
Throws
NullPointerException - if either tagsToInclude or tagsToExclude are null
IllegalArgumentException - if tagsToInclude is defined, but contains an empty set
Method Summary
def apply (testNames : scala.collection.immutable.Set[java.lang.String], tags : scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) : scala.List[(java.lang.String, Boolean)]
Filter test names based on their tags.
def apply (testName : java.lang.String, tags : scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) : (Boolean, Boolean)
Filter one test name based on its tags.
def runnableTestCount (testNames : scala.collection.immutable.Set[java.lang.String], tags : scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) : Int
Returns the number of tests that should be run after the passed testNames and tags have been filtered with the tagsToInclude and tagsToExclude class parameters.
Methods inherited from scala.Function2
scala.Function2.toString, scala.Function2.curry
Methods inherited from AnyRef
getClass, hashCode, equals, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Method Details
def apply(testNames : scala.collection.immutable.Set[java.lang.String], tags : scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) : scala.List[(java.lang.String, Boolean)]
Filter test names based on their tags.

Each tuple in the returned list contains a String test name and a Boolean that indicates whether the test should be ignored. A test will be marked as ignored if org.scalatest.Ignore is in its tags set, and either tagsToInclude is None, or tagsToInclude's value (a set) contains the test's name, unless another tag for that test besides org.scalatest.Ignore is also included in tagsToExclude. For example, if a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolasses appears in the tagsToExclude set, the SlowAsMolasses tag will "overpower" the org.scalatest.Ignore tag, and this method will return a list that does not include the test name. 

   for ((testName, ignoreTest) <- filter(testNames, tags))
     if (ignoreTest)
       // ignore the test
     else
       // execute the test
Parameters
testNames - test names to be filtered
tags - a map from test name to tags, containing only test names included in the testNames set, and only test names that have at least one tag
Throws
IllegalArgumentException - if any set contained in the passed tags map is empty
Overrides
scala.Function2.scala.Function2.apply
def apply(testName : java.lang.String, tags : scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) : (Boolean, Boolean)
Filter one test name based on its tags.

The returned tuple contains a Boolean that indicates whether the test should be filtered, and if not, a Boolean that indicates whether the test should be ignored. A test will be marked as ignored if org.scalatest.Ignore is in its tags set, and either tagsToInclude is None, or tagsToInclude's value (a set) contains the passed test name, unless another tag for that test besides org.scalatest.Ignore is also included in tagsToExclude. For example, if a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolasses appears in the tagsToExclude set, the SlowAsMolasses tag will "overpower" the org.scalatest.Ignore tag, and this method will return (true, false). 

   val (filterTest, ignoreTest) = filter(testName, tags)
   if (!filterTest)
     if (ignoreTest)
       // ignore the test
     else
       // execute the test
Parameters
testName - the test name to be filtered
tags - a map from test name to tags, containing only test names that have at least one tag
Throws
IllegalArgumentException - if any set contained in the passed tags map is empty
def runnableTestCount(testNames : scala.collection.immutable.Set[java.lang.String], tags : scala.collection.immutable.Map[java.lang.String, scala.collection.immutable.Set[java.lang.String]]) : Int
Returns the number of tests that should be run after the passed testNames and tags have been filtered with the tagsToInclude and tagsToExclude class parameters.

The result of this method may be smaller than the number of elements in the list returned by apply, because the count returned by this method does not include ignored tests, and the list returned by apply does include ignored tests.

Parameters
testNames - test names to be filtered
tags - a map from test name to tags, containing only test names included in the testNames set, and only test names that have at least one tag
Throws
IllegalArgumentException - if any set contained in the passed tags map is empty
Copyright (C) 2001-2010 Artima, Inc. All rights reserved.
ScalaTest 1.1