words

Type Members

final class BeWord extends AnyRef

This class is part of the ScalaTest matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers or MustMatchers for an overview of the matchers DSL.

Class BeWord contains an apply method that takes a Symbol, which uses reflection to find and access a Boolean property and determine if it is true. If the symbol passed is 'empty, for example, the apply method will use reflection to look for a public Java field named "empty", a public method named "empty", or a public method named "isEmpty". If a field, it must be of type Boolean. If a method, it must take no parameters and return Boolean. If multiple candidates are found, the apply method will select based on the following algorithm:

Field	Method	"is" Method	Result
			Throws `TestFailedException`, because no candidates found
		`isEmpty()`	Invokes `isEmpty()`
	`empty()`		Invokes `empty()`
	`empty()`	`isEmpty()`	Invokes `empty()` (this can occur when `BeanProperty` annotation is used)
`empty`			Accesses field `empty`
`empty`		`isEmpty()`	Invokes `isEmpty()`
`empty`	`empty()`		Invokes `empty()`
`empty`	`empty()`	`isEmpty()`	Invokes `empty()` (this can occur when `BeanProperty` annotation is used)

final class BehaveWord extends AnyRef

Class that supports shared test registration via instances referenced from the behave field of FunSpecs, FlatSpecs, and WordSpecs as well as instance of their sister traits, fixture.FunSpec, fixture.FlatSpec, and fixture.WordSpec.
Class that supports shared test registration via instances referenced from the behave field of FunSpecs, FlatSpecs, and WordSpecs as well as instance of their sister traits, fixture.FunSpec, fixture.FlatSpec, and fixture.WordSpec.
This class, via the behave field, enables syntax such as the following in FunSpecs, FlatSpecs, fixture.FunSpecs, and fixture.FlatSpecs:
```
it should behave like nonFullStack(stackWithOneItem)
          ^
```
It also enables syntax such as the following syntax in WordSpecs and fixture.WordSpecs:
```
behave like nonEmptyStack(lastValuePushed)
^
```
For more information and examples of the use of <cod>behave, see the Shared tests section in the main documentation for trait FunSpec, FlatSpec, or WordSpec.
trait CanVerb extends AnyRef

Provides an implicit conversion that adds can methods to String to support the syntax of FlatSpec, WordSpec, org.scalatest.fixture.FlatSpec, and fixture.WordSpec.
Provides an implicit conversion that adds can methods to String to support the syntax of FlatSpec, WordSpec, org.scalatest.fixture.FlatSpec, and fixture.WordSpec.
For example, this trait enables syntax such as the following test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" can "be empty" in { ... }
                       ^
```
It also enables syntax such as the following shared test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (with one item)" can behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
                          ^
```
In addition, it supports the registration of subject descriptions in WordSpec and fixture.WordSpec, such as:
```
"A Stack (when empty)" can { ...
                       ^
```
And finally, it also supportds the registration of subject descriptions with after words in WordSpec and fixture.WordSpec. For example:
```
   def provide = afterWord("provide")

  "The ScalaTest Matchers DSL" can provide {
                               ^
```
The reason this implicit conversion is provided in a separate trait, instead of being provided directly in FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec, is primarily for design symmetry with ShouldVerb and MustVerb. Both ShouldVerb and MustVerb must exist as a separate trait because an implicit conversion provided directly would conflict with the implicit conversion that provides should or must methods on String in the Matchers and MustMatchers traits.
final class CompileWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ContainWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class DefinedWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class EmptyWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class EndWithWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ExistWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class FullyMatchWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class HaveWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class IncludeWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class LengthWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class MatchPatternWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
trait MatcherWords extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
trait MustVerb extends AnyRef

Provides an implicit conversion that adds must methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
Provides an implicit conversion that adds must methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
For example, this trait enables syntax such as the following test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" must "be empty" in { ... }
                       ^
```
It also enables syntax such as the following shared test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (with one item)" must behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
                          ^
```
In addition, it supports the registration of subject descriptions in WordSpec and fixture.WordSpec, such as:
```
"A Stack (when empty)" must { ...
                       ^
```
And finally, it also supportds the registration of subject descriptions with after words in WordSpec and fixture.WordSpec. For example:
```
   def provide = afterWord("provide")

  "The ScalaTest Matchers DSL" must provide {
                               ^
```
The reason this implicit conversion is provided in a separate trait, instead of being provided directly in FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec, is because an implicit conversion provided directly would conflict with the implicit conversion that provides must methods on String in the MustMatchers trait. By contrast, there is no conflict with the separate MustVerb trait approach, because:
- FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec mix in MustVerb directly, and
- MustMatchers extends MustVerb, overriding the convertToStringMustWrapper implicit conversion function.
So whether or not a FlatSpec, WordSpec, fixture.FlatSpec, or fixture.WordSpec mixes in MustMatchers, there will only be one implicit conversion in scope that adds must methods to Strings.
Also, because the class of the result of the overriding convertToStringMustWrapper implicit conversion method provided in MustMatchers extends this trait's StringMustWrapperForVerb class, the four uses of must provided here are still available. These four must are in fact available to any class that mixes in MustMatchers, but each takes an implicit parameter that is provided only in FlatSpec and fixture.FlatSpec, or WordSpec and fixture.WordSpec.
final class NoExceptionWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class NotWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class PleaseUseNoExceptionShouldSyntaxInstead extends AnyRef
final class ReadableWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class RegexWithGroups extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfATypeInvocation[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAWordToAMatcherApplication[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAWordToBePropertyMatcherApplication[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAWordToSymbolApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAfterWordApplication extends AnyRef

Class that supports the use of after words in WordSpec and fixture.WordSpec.
Class that supports the use of after words in WordSpec and fixture.WordSpec.
A ResultOfAfterWordApplication, which encapsulates the text of the after word and a block, is accepted by when, should, must, can, and that methods. For more information, see the main documentation for trait WordSpec.
class ResultOfAllElementsOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfAllOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAnTypeInvocation[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAnWordToAnMatcherApplication[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAnWordToBePropertyMatcherApplication[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfAnWordToSymbolApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfAtLeastOneElementOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfAtLeastOneOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfAtMostOneElementOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfAtMostOneOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfBeThrownBy extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfBeWordForAType[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfBeWordForAnType[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfBeWordForNoException extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfContainWord[L] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfDefinedAt[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfGreaterThanComparison[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfGreaterThanOrEqualToComparison[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfInOrderApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfInOrderElementsOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfInOrderOnlyApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfKeyWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfLengthWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfLessThanComparison[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfLessThanOrEqualToComparison[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfMessageWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfNoElementsOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfNoneOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfNotExist extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
sealed class ResultOfNotWordForAny[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfOfTypeInvocation[T] extends AnyRef
class ResultOfOneElementOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfOneOfApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfOnlyApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfRegexWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
The primary constructor enables the following syntax (with a passed scala.util.matching.Regex):
```
"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)
                              ^
```
final class ResultOfSizeWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
abstract class ResultOfStringPassedToVerb extends AnyRef

Abstract class that supports test registration in FlatSpec and fixture.FlatSpec.
Abstract class that supports test registration in FlatSpec and fixture.FlatSpec.
For example, this class enables syntax such as the following pending test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" should "be empty" is (pending)
                                         ^
```
For example, this class enables syntax such as the following tagged test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" should "be empty" taggedAs(SlowTet) in { ... }
                                         ^
```
This class also indirectly enables syntax such as the following regular test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" should "be empty" in { ... }
                                         ^
```
However, this class does not declare any methods named in, because the type passed to in differs in a FlatSpec and a fixture.FlatSpec. A fixture.FlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture as its parameter). By constrast, a FlatSpec needs only one in method that takes a by-name parameter. As a result, FlatSpec and fixture.FlatSpec each provide an implicit conversion from ResultOfStringPassedToVerb to a type that provides the appropriate in methods.
abstract class ResultOfTaggedAsInvocation extends AnyRef

Supports the registration of tagged tests in shorthand form in FlatSpec and fixture.FlatSpec.
Supports the registration of tagged tests in shorthand form in FlatSpec and fixture.FlatSpec.
For example, this class enables syntax such as the following tagged, pending test registration in shorthand form:
```
"A Stack (when empty)" should "be empty" taggedAs() is (pending)
                                                    ^
```
In addition, this class indirectly enables syntax such as the following tagged test registration in shorthand form:
```
"A Stack (when empty)" should "be empty" taggedAs() in { ... }
                                                    ^
```
Rather than provide in and ignore methods directly, these methods are provided after taggedAs() by implicit conversions because the type passed to in (and ignore) differs in a FlatSpec and a fixture.FlatSpec. A fixture.FlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture as its parameter). By constrast, a FlatSpec needs only one in method that takes a by-name parameter. As a result, FlatSpec and fixture.FlatSpec each provide an implicit conversion from ResultOfTaggedAsInvocation to a type that provides the appropriate in methods.
class ResultOfTheSameElementsAsApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
class ResultOfTheSameElementsInOrderAsApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfTheSameInstanceAsApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfTheTypeInvocation[T] extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfThrownByApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class ResultOfValueWordApplication extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
trait ShouldVerb extends AnyRef

Provides an implicit conversion that adds should methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
Provides an implicit conversion that adds should methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
For example, this trait enables syntax such as the following test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" should "be empty" in { ... }
                       ^
```
It also enables syntax such as the following shared test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
                          ^
```
In addition, it supports the registration of subject descriptions in WordSpec and fixture.WordSpec, such as:
```
"A Stack (when empty)" should { ...
                       ^
```
And finally, it also supportds the registration of subject descriptions with after words in WordSpec and fixture.WordSpec. For example:
```
   def provide = afterWord("provide")

  "The ScalaTest Matchers DSL" should provide {
                               ^
```
The reason this implicit conversion is provided in a separate trait, instead of being provided directly in FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec, is because an implicit conversion provided directly would conflict with the implicit conversion that provides should methods on String in the Matchers trait. By contrast, there is no conflict with the separate ShouldVerb trait approach, because:
- FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec mix in ShouldVerb directly, and
- Matchers extends ShouldVerb, overriding the convertToStringShouldWrapper implicit conversion function.
So whether or not a FlatSpec, WordSpec, fixture.FlatSpec, or fixture.WordSpec mixes in Matchers, there will only be one implicit conversion in scope that adds should methods to Strings.
Also, because the class of the result of the overriding convertToStringShouldWrapper implicit conversion method provided in Matchers extends this trait's StringShouldWrapperForVerb class, the four uses of should provided here are still available. These four should are in fact available to any class that mixes in Matchers, but each takes an implicit parameter that is provided only in FlatSpec and fixture.FlatSpec, or WordSpec and fixture.WordSpec.
final class SizeWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class SortedWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
final class StartWithWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
abstract class StringVerbBlockRegistration extends (String, String, () ⇒ Unit) ⇒ Unit

Class that provides a role-specific type for an implicit conversion used to support the registration of subject descriptions in WordSpec and fixture.WordSpec.
Class that provides a role-specific type for an implicit conversion used to support the registration of subject descriptions in WordSpec and fixture.WordSpec.
For example, this class enables syntax such as the following in WordSpec and fixture.WordSpec:
```
"A Stack (when empty)" should { ...
                       ^
```
This should method, which is provided in ShouldVerb, needs an implicit parameter of type (String, String, () => Unit) => Unit. Because the required type has no ScalaTest-specific types in it, it is possible that another implicit parameter of that same type could be in scope, which would cause a compile failure. Requiring an implicit parameter of the more specific StringVerbBlockRegistration, which simply extends the needed type, (String, String, () => Unit) => Unit, avoids this potential conflict.
final class TypeCheckWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.
trait WillVerb extends AnyRef

Provides an implicit conversion that adds will methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
Provides an implicit conversion that adds will methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.
For example, this trait enables syntax such as the following test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (when empty)" will "be empty" in { ... }
                       ^
```
It also enables syntax such as the following shared test registration in FlatSpec and fixture.FlatSpec:
```
"A Stack (with one item)" will behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
                          ^
```
In addition, it supports the registration of subject descriptions in WordSpec and fixture.WordSpec, such as:
```
"A Stack (when empty)" will { ...
                       ^
```
And finally, it also supportds the registration of subject descriptions with after words in WordSpec and fixture.WordSpec. For example:
```
   def provide = afterWord("provide")

  "The ScalaTest Matchers DSL" will provide {
                               ^
```
The reason this implicit conversion is provided in a separate trait, instead of being provided directly in FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec, is because an implicit conversion provided directly would conflict with the implicit conversion that provides will methods on String in the Matchers trait. By contrast, there is no conflict with the separate WillVerb trait approach, because:
- FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec mix in WillVerb directly, and
- Matchers extends WillVerb, overriding the convertToStringWillWrapper implicit conversion function.
So whether or not a FlatSpec, WordSpec, fixture.FlatSpec, or fixture.WordSpec mixes in Matchers, there will only be one implicit conversion in scope that adds will methods to Strings.
Also, because the class of the result of the overriding convertToStringWillWrapper implicit conversion method provided in Matchers extends this trait's StringWillWrapperForVerb class, the four uses of will provided here are still available. These four will are in fact available to any class that mixes in Matchers, but each takes an implicit parameter that is provided only in FlatSpec and fixture.FlatSpec, or WordSpec and fixture.WordSpec.
final class WritableWord extends AnyRef

This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

Value Members

object MatcherWords extends MatcherWords

package words

Type Members

final class BeWord extends AnyRef

final class BehaveWord extends AnyRef

trait CanVerb extends AnyRef

final class CompileWord extends AnyRef

final class ContainWord extends AnyRef

final class DefinedWord extends AnyRef

final class EmptyWord extends AnyRef

final class EndWithWord extends AnyRef

final class ExistWord extends AnyRef

final class FullyMatchWord extends AnyRef

final class HaveWord extends AnyRef

final class IncludeWord extends AnyRef

final class LengthWord extends AnyRef

final class MatchPatternWord extends AnyRef

trait MatcherWords extends AnyRef

trait MustVerb extends AnyRef

final class NoExceptionWord extends AnyRef

final class NotWord extends AnyRef

final class PleaseUseNoExceptionShouldSyntaxInstead extends AnyRef

final class ReadableWord extends AnyRef

final class RegexWithGroups extends AnyRef

final class ResultOfATypeInvocation[T] extends AnyRef

final class ResultOfAWordToAMatcherApplication[T] extends AnyRef

final class ResultOfAWordToBePropertyMatcherApplication[T] extends AnyRef

final class ResultOfAWordToSymbolApplication extends AnyRef

final class ResultOfAfterWordApplication extends AnyRef

class ResultOfAllElementsOfApplication extends AnyRef

class ResultOfAllOfApplication extends AnyRef

final class ResultOfAnTypeInvocation[T] extends AnyRef

final class ResultOfAnWordToAnMatcherApplication[T] extends AnyRef

final class ResultOfAnWordToBePropertyMatcherApplication[T] extends AnyRef

final class ResultOfAnWordToSymbolApplication extends AnyRef

class ResultOfAtLeastOneElementOfApplication extends AnyRef

class ResultOfAtLeastOneOfApplication extends AnyRef

class ResultOfAtMostOneElementOfApplication extends AnyRef

class ResultOfAtMostOneOfApplication extends AnyRef

final class ResultOfBeThrownBy extends AnyRef

final class ResultOfBeWordForAType[T] extends AnyRef

final class ResultOfBeWordForAnType[T] extends AnyRef

final class ResultOfBeWordForNoException extends AnyRef

class ResultOfContainWord[L] extends AnyRef

final class ResultOfDefinedAt[T] extends AnyRef

final class ResultOfGreaterThanComparison[T] extends AnyRef

final class ResultOfGreaterThanOrEqualToComparison[T] extends AnyRef

class ResultOfInOrderApplication extends AnyRef

class ResultOfInOrderElementsOfApplication extends AnyRef

class ResultOfInOrderOnlyApplication extends AnyRef

final class ResultOfKeyWordApplication extends AnyRef

final class ResultOfLengthWordApplication extends AnyRef

final class ResultOfLessThanComparison[T] extends AnyRef

final class ResultOfLessThanOrEqualToComparison[T] extends AnyRef

final class ResultOfMessageWordApplication extends AnyRef

class ResultOfNoElementsOfApplication extends AnyRef

class ResultOfNoneOfApplication extends AnyRef

final class ResultOfNotExist extends AnyRef

sealed class ResultOfNotWordForAny[T] extends AnyRef

final class ResultOfOfTypeInvocation[T] extends AnyRef

class ResultOfOneElementOfApplication extends AnyRef

class ResultOfOneOfApplication extends AnyRef

class ResultOfOnlyApplication extends AnyRef

final class ResultOfRegexWordApplication extends AnyRef

final class ResultOfSizeWordApplication extends AnyRef

abstract class ResultOfStringPassedToVerb extends AnyRef

abstract class ResultOfTaggedAsInvocation extends AnyRef

class ResultOfTheSameElementsAsApplication extends AnyRef

class ResultOfTheSameElementsInOrderAsApplication extends AnyRef

final class ResultOfTheSameInstanceAsApplication extends AnyRef

final class ResultOfTheTypeInvocation[T] extends AnyRef

final class ResultOfThrownByApplication extends AnyRef

final class ResultOfValueWordApplication extends AnyRef

trait ShouldVerb extends AnyRef

final class SizeWord extends AnyRef

final class SortedWord extends AnyRef

final class StartWithWord extends AnyRef

abstract class StringVerbBlockRegistration extends (String, String, () ⇒ Unit) ⇒ Unit

final class TypeCheckWord extends AnyRef

trait WillVerb extends AnyRef