org.scalatest

Filter

class Filter extends (Set[String], Map[String, Set[String]]) ⇒ List[(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 thetagsToInclude 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 tagsToExcludeset. For example, if SlowAsMolasses is a member of the tagsToInclude set and a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, andSlowAsMolasses appears in the tagsToExclude set, theSlowAsMolasses tag will "overpower" the org.scalatest.Ignore tag, and the test will be filtered out entirely rather than being ignored.

attributes: final
go to: companion
linear super types: (Set[String], Map[String, Set[String]]) ⇒ List[(String, Boolean)], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Filter
  2. Function2
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new Filter (tagsToInclude: Option[Set[String]], tagsToExclude: Set[String])

    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

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def apply (testName: String, tags: Map[String, Set[String]]) : (Boolean, Boolean)

    Filter one test name based on its tags.

    Filter one test name based on its tags.

    The returned tuple contains a Booleanthat 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 tagsToIncludeis None, or tagsToInclude's value (a set) contains the passed test name, unless another tag for that test besides org.scalatest.Ignoreis also included in tagsToExclude. For example, if a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolassesappears 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

    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

  9. def apply (testNames: Set[String], tags: Map[String, Set[String]]) : List[(String, Boolean)]

    Filter test names based on their tags.

    Filter test names based on their tags.

    Each tuple in the returned list contains a Stringtest 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, ortagsToInclude's value (a set) contains the test's name, unless another tag for that test besides org.scalatest.Ignoreis also included in tagsToExclude. For example, if a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolassesappears 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

    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

    definition classes: Filter → Function2
  10. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  11. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  12. def curried : (Set[String]) ⇒ (Map[String, Set[String]]) ⇒ List[(String, Boolean)]

    definition classes: Function2
  13. def curry : (Set[String]) ⇒ (Map[String, Set[String]]) ⇒ List[(String, Boolean)]

    definition classes: Function2
      deprecated:
    1. Use 'curried' instead

  14. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  15. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  16. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  17. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  18. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  19. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  20. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  21. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  22. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  23. def runnableTestCount (testNames: Set[String], tags: Map[String, Set[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.

    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.

    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

  24. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  25. val tagsToExclude : Set[String]

    a Set of String tag names to exclude (i.

    a Set of String tag names to exclude (i.e., filter out) when filtering tests

  26. val tagsToInclude : Option[Set[String]]

    an optional Set of String tag names to include (i.

    an optional Set of String tag names to include (i.e., not filter out) when filtering tests

  27. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: Function2 → AnyRef → Any
  28. def tupled : ((Set[String], Map[String, Set[String]])) ⇒ List[(String, Boolean)]

    definition classes: Function2
  29. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  30. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  31. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from (Set[String], Map[String, Set[String]]) ⇒ List[(String, Boolean)]

Inherited from AnyRef

Inherited from Any