org.scalatest.WordSpec

class WordSpecStringWrapper

[source: org/scalatest/WordSpec.scala]

protected final class WordSpecStringWrapper(string : java.lang.String)
extends AnyRef
A class that via an implicit conversion (named convertToWordSpecStringWrapper) enables methods when, that, in, is, taggedAs and ignore to be invoked on Strings.

This class provides much of the syntax for WordSpec, however, it does not add the verb methods (should, must, and can) to String. Instead, these are added via the ShouldVerb, MustVerb, and CanVerb traits, which WordSpec mixes in, to avoid a conflict with implicit conversions provided in ShouldMatchers and MustMatchers.

Author
Bill Venners
Method Summary
def ignore (f : => Unit) : Unit
Supports ignored test registration.
def in (f : => Unit) : Unit
Supports test registration.
def is (f : => PendingNothing) : Unit
Supports pending test registration.
def taggedAs (firstTestTag : Tag, otherTestTags : Tag*) : ResultOfTaggedAsInvocationOnString
Supports tagged test registration.
def that (resultOfAfterWordApplication : ResultOfAfterWordApplication) : Unit
Registers a that clause that is followed by an after word.
def that (f : => Unit) : Unit
Registers a that clause.
def when (f : => Unit) : Unit
Registers a when clause.
def when (resultOfAfterWordApplication : ResultOfAfterWordApplication) : Unit
Registers a when clause that is followed by an after word.
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(f : => Unit) : Unit
Supports test registration.

For example, this method supports syntax such as the following:

     "complain on peek" in { ... }
                        ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def ignore(f : => Unit) : Unit
Supports ignored test registration.

For example, this method supports syntax such as the following:

     "complain on peek" ignore { ... }
                        ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def is(f : => PendingNothing) : Unit
Supports pending test registration.

For example, this method supports syntax such as the following:

     "complain on peek" is (pending)
                        ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def taggedAs(firstTestTag : Tag, otherTestTags : Tag*) : ResultOfTaggedAsInvocationOnString
Supports tagged test registration.

For example, this method supports syntax such as the following:

     "complain on peek" taggedAs(SlowTest) in { ... }
                        ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def when(f : => Unit) : Unit
Registers a when clause.

For example, this method supports syntax such as the following:

     "A Stack" when { ... }
               ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def when(resultOfAfterWordApplication : ResultOfAfterWordApplication) : Unit
Registers a when clause that is followed by an after word.

For example, this method supports syntax such as the following:

     val theUser = afterWord("the user")
    
     "A Stack" when theUser { ... }
               ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def that(f : => Unit) : Unit
Registers a that clause.

For example, this method supports syntax such as the following:

     "a rerun button" that {
                      ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.


def that(resultOfAfterWordApplication : ResultOfAfterWordApplication) : Unit
Registers a that clause that is followed by an after word.

For example, this method supports syntax such as the following:

     def is = afterWord("is")
    
     "a rerun button" that is {
                      ^
     

For more information and examples of this method's use, see the main documentation for trait WordSpec.



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