org.scalatest.FlatSpec

class IgnoreVerbString

[source: org/scalatest/FlatSpec.scala]

protected final class IgnoreVerbString(verb : java.lang.String, name : java.lang.String)
extends AnyRef
Class that supports registration of ignored tests via the IgnoreWord instance referenced from FlatSpec's ignore field.

This class enables syntax such as the following registration of an ignored test:

   ignore should "pop values in last-in-first-out order" in { ... }
                                                         ^
   

In addition, it enables syntax such as the following registration of an ignored, pending test:

   ignore should "pop values in last-in-first-out order" is (pending)
                                                         ^
   

Note: the is method is provided for completeness and design symmetry, given there's no way to prevent changing is to ignore and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.

And finally, it also enables syntax such as the following ignored, tagged test registration:

   ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                         ^
   

For more information and examples of the use of the ignore field, see the Ignored tests section in the main documentation for trait FlatSpec.

Method Summary
def in (testFun : => Unit) : Unit
Supports the registration of ignored tests in a FlatSpec.
def is (testFun : => PendingNothing) : Unit
Supports the registration of ignored, pending tests in a FlatSpec.
def taggedAs (firstTestTag : Tag, otherTestTags : Tag*) : IgnoreVerbStringTaggedAs
Supports the registration of ignored, tagged tests in a FlatSpec.
Methods inherited from AnyRef
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Method Details
def in(testFun : => Unit) : Unit
Supports the registration of ignored tests in a FlatSpec.

This method supports syntax such as the following:

     ignore must "pop values in last-in-first-out order" in { ... }
                                                         ^
     

For examples of the registration of ignored tests, see the Ignored tests section in the main documentation for trait FlatSpec.


def is(testFun : => PendingNothing) : Unit
Supports the registration of ignored, pending tests in a FlatSpec.

This method supports syntax such as the following:

     ignore must "pop values in last-in-first-out order" is (pending)
                                                         ^
     

Note: this is method is provided for completeness and design symmetry, given there's no way to prevent changing is to ignore and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.

For examples of pending test registration, see the Pending tests section in the main documentation for trait FlatSpec. For examples of the registration of ignored tests, see the Ignored tests section in the main documentation for trait FlatSpec.


def taggedAs(firstTestTag : Tag, otherTestTags : Tag*) : IgnoreVerbStringTaggedAs
Supports the registration of ignored, tagged tests in a FlatSpec.

This method supports syntax such as the following:

     ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                         ^
     

For examples of tagged test registration, see the Tagging tests section in the main documentation for trait FlatSpec. For examples of the registration of ignored tests, see the Ignored tests section in the main documentation for trait FlatSpec.



Copyright (C) 2001-2009 Artima, Inc. All rights reserved.