org.scalatest.matchers.DeprecatedMatchers.saveme Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of scalatest_2.11.0-M3 Show documentation

ScalaTest is a free, open-source testing toolkit for Scala and Java programmers.

There is a newer version: 2.0.M6-SNAP27

/*
 * Copyright 2001-2008 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalatest.matchers

import org.scalatest._
import java.lang.reflect.Method
import java.lang.reflect.Modifier
import scala.util.matching.Regex
import java.lang.reflect.Field
import scala.reflect.Manifest
import Helper.transformOperatorChars
import Assertions.areEqualComparingArraysStructurally

// TODO: drop generic support for be as an equality comparison, in favor of specific ones.
// TODO: mention on JUnit and TestNG docs that you can now mix in DeprecatedShouldMatchers or DeprecatedMustMatchers
// TODO: Put links from DeprecatedShouldMatchers to wherever I reveal the matrix and algo of how properties are checked dynamically.
// TODO: double check that I wrote tests for (length (7)) and (size (8)) in parens
// TODO: document how to turn off the === implicit conversion
// TODO: Document you can use JMock, EasyMock, etc.

import Helper.accessProperty

/**
 * This trait is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or
 * DeprecatedMustMatchers for an overview of the matchers DSL.
 *
 * @author Bill Venners
 */
trait DeprecatedMatchers extends Assertions { matchers =>

  private[scalatest] def newTestFailedException(message: String): Throwable = {
    val fileNames = List("DeprecatedMatchers.scala", "DeprecatedShouldMatchers.scala", "DeprecatedMustMatchers.scala")
    val temp = new RuntimeException
    val stackDepth = temp.getStackTrace.takeWhile(stackTraceElement => fileNames.exists(_ == stackTraceElement.getFileName) || stackTraceElement.getMethodName == "newTestFailedException").length
    new TestFailedException(message, stackDepth)
  }

  private def matchSymbolToPredicateMethod[S <: AnyRef](left: S, right: Symbol, hasArticle: Boolean, articleIsA: Boolean): MatchResult = {

    // If 'empty passed, rightNoTick would be "empty"
    val propertyName = right.name

    accessProperty(left, right, true) match {

      case None =>

        // if propertyName is '>, mangledPropertyName would be "$greater"
        val mangledPropertyName = transformOperatorChars(propertyName)

        // methodNameToInvoke would also be "empty"
        val methodNameToInvoke = mangledPropertyName

        // methodNameToInvokeWithIs would be "isEmpty"
        val methodNameToInvokeWithIs = "is"+ mangledPropertyName(0).toUpper + mangledPropertyName.substring(1)

        val firstChar = propertyName(0).toLower
        val methodNameStartsWithVowel = firstChar == 'a' || firstChar == 'e' || firstChar == 'i' ||
          firstChar == 'o' || firstChar == 'u'

        throw newTestFailedException(
          FailureMessages(
            if (methodNameStartsWithVowel) "hasNeitherAnOrAnMethod" else "hasNeitherAOrAnMethod",
            left,
            UnquotedString(methodNameToInvoke),
            UnquotedString(methodNameToInvokeWithIs)
          )
        )

      case Some(result) =>

        val (wasNot, was) =
          if (hasArticle) {
            if (articleIsA) ("wasNotA", "wasA") else ("wasNotAn", "wasAn")
          }
          else ("wasNot", "was")

        MatchResult(
          result == true, // Right now I just leave the return value of accessProperty as Any
          FailureMessages(wasNot, left, UnquotedString(propertyName)),
          FailureMessages(was, left, UnquotedString(propertyName))
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class MatcherWrapper[T](leftMatcher: Matcher[T]) { matchersWrapper =>

// TODO: mention not short circuited, and the precendence is even between and and or

    /**
     * Returns a matcher whose apply method returns a MatchResult
     * that represents the logical-and of the results of the wrapped and the passed matcher applied to
     * the same value.
     *
     * 
     * The reason and has an upper bound on its type parameter is so that the Matcher
     * resulting from an invocation of and will have the correct type parameter. If you call
     * and on a Matcher[Orange], passing in a Matcher[Valencia],
     * the result will have type Matcher[Valencia]. This is correct because both a
     * Matcher[Orange] and a Matcher[Valencia] know how to match a
     * Valencia (but a Matcher[Valencia] doesn't know how to
     * match any old Orange).  If you call
     * and on a Matcher[Orange], passing in a Matcher[Fruit],
     * the result will have type Matcher[Orange]. This is also correct because both a
     * Matcher[Orange] and a Matcher[Fruit] know how to match an
     * Orange (but a Matcher[Orange] doesn't know how to
     * match any old Fruit).
     * 
     *
     * @param the matcher to logical-and with this matcher
     * @return a matcher that performs the logical-and of this and the passed matcher
     */
    def and[U <: T](rightMatcher: Matcher[U]): Matcher[U] =
      new Matcher[U] {
        def apply(left: U) = {
          val leftMatchResult = leftMatcher(left)
          val rightMatchResult = rightMatcher(left) // Not short circuiting anymore
          if (!leftMatchResult.matches)
            MatchResult(
              false,
              leftMatchResult.failureMessage,
              leftMatchResult.negatedFailureMessage,
              leftMatchResult.midSentenceFailureMessage,
              leftMatchResult.midSentenceNegatedFailureMessage
            )
          else {
            MatchResult(
              rightMatchResult.matches,
              Resources("commaBut", leftMatchResult.negatedFailureMessage, rightMatchResult.midSentenceFailureMessage),
              Resources("commaAnd", leftMatchResult.negatedFailureMessage, rightMatchResult.midSentenceNegatedFailureMessage),
              Resources("commaBut", leftMatchResult.midSentenceNegatedFailureMessage, rightMatchResult.midSentenceFailureMessage),
              Resources("commaAnd", leftMatchResult.midSentenceNegatedFailureMessage, rightMatchResult.midSentenceNegatedFailureMessage)
            )
          }
        }
      }

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndHaveWord {

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (have length (2) and have length (3 - 1))
       *                                              ^
       * 
       */
      def length(expectedLength: Long) = and(have.length(expectedLength))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (have size (2) and have size (3 - 1))
       *                                            ^ 
       * 
       */
      def size(expectedSize: Long) = and(have.size(expectedSize))
    }

    /**
     * This method enables the following syntax:
     *
     *      * Array(1, 2) should (have size (2) and have size (3 - 1))
     *                                   ^ 
     * 
     */
    def and(haveWord: HaveWord): AndHaveWord = new AndHaveWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndContainWord {

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (contain (2) and contain (3 - 1))
       *                                             
       * 
       */
      def apply[T](expectedElement: T) = matchersWrapper.and(matchers.contain(expectedElement))
      // def element[T](expectedElement: T) = matchersWrapper.and(matchers.contain.apply(expectedElement))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (contain key ("two") and contain key ("one"))
       *                                                                     ^
       * 
       */
      def key[T](expectedElement: T) = matchersWrapper.and(matchers.contain.key(expectedElement))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (contain value (2) and contain value (1))
       *                                                                   ^
       * 
       */
      def value[T](expectedValue: T) = matchersWrapper.and(matchers.contain.value(expectedValue))
    }

    /**
     * This method enables the following syntax:
     *
     *      * Map("one" -> 1, "two" -> 2) should (contain key ("two") and contain key ("one"))
     *                                                         ^ 
     * 
     */
    def and(containWord: ContainWord): AndContainWord = new AndContainWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndBeWord {

      /**
       * This method enables the following syntax:
       *
       *        * isFileMock should (be a ('file) and be a ('file))
       *                                        ^
       * 
       */
      def a(symbol: Symbol) = and(be.a(symbol))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (be a (file) and be a (file))
       *                                        ^
       * 
       */
      def a[T](bePropertyMatcher: BePropertyMatcher[T]) = and(be.a(bePropertyMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * isAppleMock should (be an ('apple) and be an ('apple))
       *                                           ^
       * 
       */
      def an(symbol: Symbol) = and(be.an(symbol))

      /**
       * This method enables the following syntax:
       *
       *        * isAppleMock should (be an (apple) and be an (apple))
       *                                           ^
       * 
       */
      def an[T](bePropertyMatcher: BePropertyMatcher[T]) = and(be.an(bePropertyMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string))
       *                                                  ^
       * 
       */
      def theSameInstanceAs(anyRef: AnyRef) = and(be.theSameInstanceAs(anyRef))
    }

    /**
     * This method enables the following syntax:
     *
     *      * isFileMock should (be a ('file) and be a ('file))
     *                                 ^
     * 
     */
    def and(beWord: BeWord): AndBeWord = new AndBeWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndFullyMatchWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (fullyMatch regex (decimal) and fullyMatch regex (decimal))
       *                                                         ^
       * 
       */
      def regex(regexString: String) = and(fullyMatch.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (fullyMatch regex (decimalRegex) and fullyMatch regex (decimalRegex))
       *                                                              ^
       * 
       */
      def regex(regex: Regex) = and(fullyMatch.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "1.7" should (fullyMatch regex (decimalRegex) and fullyMatch regex (decimalRegex))
     *                                               ^
     * 
     */
    def and(fullyMatchWord: FullyMatchWord): AndFullyMatchWord = new AndFullyMatchWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndIncludeWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (include regex (decimal) and include regex (decimal))
       *                                                   ^
       * 
       */
      def regex(regexString: String) = and(include.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (include regex (decimalRegex) and include regex (decimalRegex))
       *                                                        ^
       * 
       */
      def regex(regex: Regex) = and(include.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "hello, world" should (include regex ("hel*o") and include regex ("wor.d"))
     *                                           ^
     * 
     */
    def and(includeWord: IncludeWord): AndIncludeWord = new AndIncludeWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndStartWithWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (startWith regex (decimal) and startWith regex (decimal))
       *                                                       ^
       * 
       */
      def regex(regexString: String) = and(startWith.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (startWith regex (decimalRegex) and startWith regex (decimalRegex))
       *                                                            ^
       * 
       */
      def regex(regex: Regex) = and(startWith.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "1.78" should (have length (4) and startWith regex ("1.7"))
     *                                ^
     * 
     */
    def and(startWithWord: StartWithWord): AndStartWithWord = new AndStartWithWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndEndWithWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (endWith regex (decimal) and endWith regex (decimal))
       *                                                   ^
       * 
       */
      def regex(regexString: String) = and(endWith.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (endWith regex (decimalRegex) and endWith regex (decimalRegex))
       *                                                        ^
       * 
       */
      def regex(regex: Regex) = and(endWith.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "1.7" should (endWith regex (decimalRegex) and endWith regex (decimalRegex))
     *                                            ^
     * 
     */
    def and(endWithWord: EndWithWord): AndEndWithWord = new AndEndWithWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class AndNotWord {

      /**
       * This method enables the following syntax:
       *
       *        * 1 should (not equal (2) and not equal (3 - 1))
       *                                 ^
       * 
       */
      def equal(any: Any) =
        matchersWrapper.and(matchers.not.apply(matchers.equal(any)))

      /**
       * This method enables the following syntax:
       *
       *        * 1 should (not be (2) and not be (3 - 1))
       *                              ^
       * 
       */
      def be(any: Any) =
        matchersWrapper.and(matchers.not.apply(matchers.be(any)))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (not have size (5) and not have length (3))
       *                                               ^
       * 
       */
      def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) =
        matchersWrapper.and(matchers.not.apply(matchers.have.length(resultOfLengthWordApplication.expectedLength)))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (not have size (5) and not have size (3))
       *                                               ^
       * 
       */
      def have(resultOfSizeWordApplication: ResultOfSizeWordApplication) =
        matchersWrapper.and(matchers.not.apply(matchers.have.size(resultOfSizeWordApplication.expectedSize)))

      /**
       * This method enables the following syntax:
       *
       *        * book should (not have (title ("Moby Dick")) and not have (author ("Melville")))
       *                                                     ^
       * 
       */
      def have[T](firstPropertyMatcher: HavePropertyMatcher[T, _], propertyMatchers: HavePropertyMatcher[T, _]*) =
        matchersWrapper.and(matchers.not.apply(matchers.have(firstPropertyMatcher, propertyMatchers: _*)))

      /**
       * This method enables the following syntax:
       *
       *        * 5 should (not be < (2) and not be < (6))
       *                                ^
       * 
       */
      def be[T](resultOfLessThanComparison: ResultOfLessThanComparison[T]) =
        matchersWrapper.and(matchers.not.be(resultOfLessThanComparison))

      /**
       * This method enables the following syntax:
       *
       *        * map should (contain key (7) and not be (null))
       *                                     ^
       * 
       */
      def be[T](o: Null) = matchersWrapper.and(matchers.not.be(o))

      /**
       * This method enables the following syntax:
       *
       *        * 7 should (not be > (8) and not be > (6))
       *                                ^
       * 
       */
      def be[T](resultOfGreaterThanComparison: ResultOfGreaterThanComparison[T]) =
        matchersWrapper.and(matchers.not.be(resultOfGreaterThanComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 2 should (not be <= (1) and not be <= (2))
       *                                 ^
       * 
       */
      def be[T](resultOfLessThanOrEqualToComparison: ResultOfLessThanOrEqualToComparison[T]) =
        matchersWrapper.and(matchers.not.be(resultOfLessThanOrEqualToComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 7 should (not be >= (8) and not be >= (6))
       *                                 ^
       * 
       */
      def be[T](resultOfGreaterThanOrEqualToComparison: ResultOfGreaterThanOrEqualToComparison[T]) =
        matchersWrapper.and(matchers.not.be(resultOfGreaterThanOrEqualToComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 5 should (not be === (2) and not be === (6))
       *                                  ^
       * 
       */
      def be(resultOfTripleEqualsApplication: ResultOfTripleEqualsApplication) =
        matchersWrapper.and(matchers.not.be(resultOfTripleEqualsApplication))

      /**
       * This method enables the following syntax:
       *
       *        * notEmptyMock should (not be ('empty) and not be ('empty))
       *                                              ^
       * 
       */
      def be(symbol: Symbol) = matchersWrapper.and(matchers.not.be(symbol))

      /**
       * This method enables the following syntax:
       *
       *        * 2 should (not be (odd) and not be (odd))
       *                                ^
       * 
       */
      def be[T](beMatcher: BeMatcher[T]) = matchersWrapper.and(matchers.not.be(beMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (not be (directory) and not be (directory))
       *                                              ^
       * 
       */
      def be[T](bePropertyMatcher: BePropertyMatcher[T]) = matchersWrapper.and(matchers.not.be(bePropertyMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * isNotFileMock should (not be a ('file) and not be a ('file))
       *                                                ^
       * 
       */
      def be(resultOfAWordApplication: ResultOfAWordToSymbolApplication) = matchersWrapper.and(matchers.not.be(resultOfAWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (not be a (directory) and not be a (directory))
       *                                             ^
       * 
       */
      def be[T <: AnyRef](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[T]) = matchersWrapper.and(matchers.not.be(resultOfAWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * isNotAppleMock should (not be an ('apple) and not be an ('apple)) 
       *                                                   ^
       * 
       */
      def be[T](resultOfAnWordApplication: ResultOfAnWordToSymbolApplication) = matchersWrapper.and(matchers.not.be(resultOfAnWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (not be an (directory) and not be an (directory))
       *                                              ^
       * 
       */
      def be[T <: AnyRef](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[T]) = matchersWrapper.and(matchers.not.be(resultOfAnWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * obj should (not be theSameInstanceAs (otherString) and not be theSameInstanceAs (otherString))
       *                                                            ^
       * 
       */
      def be[T](resultOfTheSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication) = matchersWrapper.and(matchers.not.be(resultOfTheSameInstanceAsApplication))

      /**
       * This method enables the following syntax:
       *
       *        * sevenDotOh should (not be (17.0 plusOrMinus 0.2) and not be (17.0 plusOrMinus 0.2))
       *                                                          ^
       * 
       */
      def be(doubleTolerance: DoubleTolerance) = matchersWrapper.and(matchers.not.be(doubleTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenDotOhFloat should (not be (17.0f plusOrMinus 0.2f) and not be (17.0f plusOrMinus 0.2f))
       *                                                                 ^
       * 
       */
      def be(floatTolerance: FloatTolerance) = matchersWrapper.and(matchers.not.be(floatTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenLong should (not be (17L plusOrMinus 2L) and not be (17L plusOrMinus 2L))
       *                                                       ^
       * 
       */
      def be(longTolerance: LongTolerance) = matchersWrapper.and(matchers.not.be(longTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenInt should (not be (17 plusOrMinus 2) and not be (17 plusOrMinus 2))
       *                                                    ^
       * 
       */
      def be(intTolerance: IntTolerance) = matchersWrapper.and(matchers.not.be(intTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenShort should (not be (17.toShort plusOrMinus 2.toShort) and not be (17.toShort plusOrMinus 2.toShort))
       *                                                                      ^
       * 
       */
      def be(shortTolerance: ShortTolerance) = matchersWrapper.and(matchers.not.be(shortTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenByte should ((not be (19.toByte plusOrMinus 2.toByte)) and (not be (19.toByte plusOrMinus 2.toByte)))
       *                                                                      ^
       * 
       */
      def be(byteTolerance: ByteTolerance) = matchersWrapper.and(matchers.not.be(byteTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not fullyMatch regex ("bob") and not fullyMatch regex (decimal))
       *                                                     ^
       * 
       */
      def fullyMatch(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.and(matchers.not.fullyMatch(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not include regex ("bob") and not include regex (decimal))
       *                                                     ^
       * 
       */
      def include(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.and(matchers.not.include(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not include ("bob") and not include ("1.7"))
       *                                            ^
       * 
       */
      def include(expectedSubstring: String) =
        matchersWrapper.and(matchers.not.include(expectedSubstring))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not startWith regex ("bob") and not startWith regex (decimal))
       *                                                    ^
       * 
       */
      def startWith(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.and(matchers.not.startWith(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not startWith ("red") and not startWith ("1.7"))
       *                                              ^
       * 
       */
      def startWith(expectedSubstring: String) =
        matchersWrapper.and(matchers.not.startWith(expectedSubstring))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not endWith regex ("bob") and not endWith regex (decimal))
       *                                                  ^
       * 
       */
      def endWith(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.and(matchers.not.endWith(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not endWith ("fre") and not endWith ("1.7"))
       *                                            ^
       * 
       */
      def endWith(expectedSubstring: String) =
        matchersWrapper.and(matchers.not.endWith(expectedSubstring))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (not contain (5) and not contain (3))
       *                                                     ^
       * 
       */
      def contain[T](expectedElement: T) =
        matchersWrapper.and(matchers.not.contain(expectedElement))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (not contain key ("five") and not contain key ("three"))
       *                                                                      ^
       * 
       */
      def contain[T](resultOfKeyWordApplication: ResultOfKeyWordApplication[T]) =
        matchersWrapper.and(matchers.not.contain(resultOfKeyWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (not contain value (5) and not contain value (3))
       *                                                                   ^
       * 
       */
      def contain[T](resultOfValueWordApplication: ResultOfValueWordApplication[T]) =
        matchersWrapper.and(matchers.not.contain(resultOfValueWordApplication))
    }

    /**
     * This method enables the following syntax:
     *
     *      * Map("one" -> 1, "two" -> 2) should (not contain value (5) and not contain value (3))
     *                                                           ^
     * 
     */
    def and(notWord: NotWord): AndNotWord = new AndNotWord

    /**
     * Returns a matcher whose apply method returns a MatchResult
     * that represents the logical-or of the results of this and the passed matcher applied to
     * the same value.
     *
     * 
     * The reason or has an upper bound on its type parameter is so that the Matcher
     * resulting from an invocation of or will have the correct type parameter. If you call
     * or on a Matcher[Orange], passing in a Matcher[Valencia],
     * the result will have type Matcher[Valencia]. This is correct because both a
     * Matcher[Orange] and a Matcher[Valencia] know how to match a
     * Valencia (but a Matcher[Valencia] doesn't know how to
     * match any old Orange).  If you call
     * or on a Matcher[Orange], passing in a Matcher[Fruit],
     * the result will have type Matcher[Orange]. This is also correct because both a
     * Matcher[Orange] and a Matcher[Fruit] know how to match an
     * Orange (but a Matcher[Orange] doesn't know how to
     * match any old Fruit).
     * 
     *
     * @param the matcher to logical-or with this matcher
     * @return a matcher that performs the logical-or of this and the passed matcher
     */
    def or[U <: T](rightMatcher: Matcher[U]): Matcher[U] =
      new Matcher[U] {
        def apply(left: U) = {
          val leftMatchResult = leftMatcher(left)
          val rightMatchResult = rightMatcher(left) // Not short circuiting anymore
          if (leftMatchResult.matches)
            MatchResult(
              true,
              leftMatchResult.negatedFailureMessage,
              leftMatchResult.failureMessage,
              leftMatchResult.midSentenceNegatedFailureMessage,
              leftMatchResult.midSentenceFailureMessage
            )
          else {
            MatchResult(
              rightMatchResult.matches,
              Resources("commaAnd", leftMatchResult.failureMessage, rightMatchResult.midSentenceFailureMessage),
              Resources("commaAnd", leftMatchResult.failureMessage, rightMatchResult.midSentenceNegatedFailureMessage),
              Resources("commaAnd", leftMatchResult.midSentenceFailureMessage, rightMatchResult.midSentenceFailureMessage),
              Resources("commaAnd", leftMatchResult.midSentenceFailureMessage, rightMatchResult.midSentenceNegatedFailureMessage)
            )
          }
        }
      }

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrHaveWord {

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (have length (2) and have length (3 - 1))
       *                                              ^
       * 
       */
      def length(expectedLength: Long) = or(have.length(expectedLength))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (have size (2) and have size (3 - 1))
       *                                       ^
       * 
       */
      def size(expectedSize: Long) = or(have.size(expectedSize))
    }

    /**
     * This method enables the following syntax:
     *
     *      * Array(1, 2) should (have size (2) and have size (3 - 1))
     *                                   ^
     * 
     */
    def or(haveWord: HaveWord): OrHaveWord = new OrHaveWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrContainWord {

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (contain (2) or contain (3 - 1))
       *                                            ^
       * 
       */
      def apply[T](expectedElement: T) = matchersWrapper.or(matchers.contain(expectedElement))
      // def element[T](expectedElement: T) = matchersWrapper.or(matchers.contain.apply(expectedElement))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (contain key ("cat") or contain key ("one"))
       *                                                                    ^
       * 
       */
      def key[T](expectedKey: T) = matchersWrapper.or(matchers.contain.key(expectedKey))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (contain value (7) or contain value (1))
       *                                                                  ^
       * 
       */
      def value[T](expectedValue: T) = matchersWrapper.or(matchers.contain.value(expectedValue))
    }

    /**
     * This method enables the following syntax:
     *
     *      * Map("one" -> 1, "two" -> 2) should (contain value (7) or contain value (1))
     *                                                       ^
     * 
     */
    def or(containWord: ContainWord): OrContainWord = new OrContainWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrBeWord {

      /**
       * This method enables the following syntax:
       *
       *        * isFileMock should (be a ('file) or be a ('directory))
       *                                       ^
       * 
       */
      def a(symbol: Symbol) = or(be.a(symbol))

      /**
       * This method enables the following syntax:
       *
       *        * isFileMock should (be a (file) or be a (directory))
       *                                      ^
       * 
       */
      def a[T](bePropertyMatcher: BePropertyMatcher[T]) = or(be.a(bePropertyMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * appleMock should (be an ('orange) or be an ('apple))
       *                                         ^
       * 
       */
      def an(symbol: Symbol) = or(be.an(symbol))

      /**
       * This method enables the following syntax:
       *
       *        * appleMock should (be an (orange) or be an (apple))
       *                                        ^
       * 
       */
      def an[T](bePropertyMatcher: BePropertyMatcher[T]) = or(be.an(bePropertyMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * obj should (be theSameInstanceAs (string) or be theSameInstanceAs (otherString))
       *                                                 ^
       * 
       */
      def theSameInstanceAs(anyRef: AnyRef) = or(be.theSameInstanceAs(anyRef))
    }

    /**
     * This method enables the following syntax:
     *
     *      * isFileMock should (be a ('file) or be a ('directory))
     *                                 ^
     * 
     */
    def or(beWord: BeWord): OrBeWord = new OrBeWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrFullyMatchWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (fullyMatch regex ("hello") or fullyMatch regex (decimal))
       *                                                        ^
       * 
       */
      def regex(regexString: String) = or(fullyMatch.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (fullyMatch regex ("hello") or fullyMatch regex (decimal))
       *                                                        ^
       * 
       */
      def regex(regex: Regex) = or(fullyMatch.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "1.7" should (fullyMatch regex ("hello") or fullyMatch regex (decimal))
     *                                          ^
     * 
     */
    def or(fullyMatchWord: FullyMatchWord): OrFullyMatchWord = new OrFullyMatchWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrIncludeWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (include regex ("hello") or include regex (decimal))
       *                                                  ^
       * 
       */
      def regex(regexString: String) = or(include.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (include regex ("hello") or include regex (decimal))
       *                                                  ^
       * 
       */
      def regex(regex: Regex) = or(include.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "a1.7b" should (include regex ("1.7") or include regex ("1.7"))
     *                                          ^
     * 
     */
    def or(includeWord: IncludeWord): OrIncludeWord = new OrIncludeWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrStartWithWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (startWith regex ("hello") or startWith regex (decimal))
       *                                                      ^
       * 
       */
      def regex(regexString: String) = or(startWith.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (startWith regex ("hello") or startWith regex (decimal))
       *                                                      ^
       * 
       */
      def regex(regex: Regex) = or(startWith.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "1.7" should (startWith regex ("hello") or startWith regex ("1.7"))
     *                                            ^
     * 
     */
    def or(startWithWord: StartWithWord): OrStartWithWord = new OrStartWithWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrEndWithWord {

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (endWith regex ("hello") or endWith regex (decimal))
       *                                                  ^
       * 
       */
      def regex(regexString: String) = or(endWith.regex(regexString))

      /**
       * This method enables the following syntax:
       *
       *        * "1.7" should (endWith regex ("hello") or endWith regex (decimal))
       *                                                  ^
       * 
       */
      def regex(regex: Regex) = or(endWith.regex(regex))
    }

    /**
     * This method enables the following syntax:
     *
     *      * "1.7b" should (endWith regex ("hello") or endWith regex ("7b"))
     *                                           ^
     * 
     */
    def or(endWithWord: EndWithWord): OrEndWithWord = new OrEndWithWord

    /**
     * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
     * the matchers DSL.
     *
     * @author Bill Venners
     */
    final class OrNotWord {

      /**
       * This method enables the following syntax:
       *
       *        * 1 should (not equal (1) or not equal (2))
       *                                ^
       * 
       */
      def equal(any: Any) =
        matchersWrapper.or(matchers.not.apply(matchers.equal(any)))

      /**
       * This method enables the following syntax:
       *
       *        * 1 should (not be (1) or not be (2))
       *                             ^
       * 
       */
      def be(any: Any) =
        matchersWrapper.or(matchers.not.apply(matchers.be(any)))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (not have length (2) or not have length (3))
       *                                                ^
       * 
       */
      def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) =
        matchersWrapper.or(matchers.not.apply(matchers.have.length(resultOfLengthWordApplication.expectedLength)))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (not have size (2) or not have size (3))
       *                                              ^
       * 
       */
      def have(resultOfSizeWordApplication: ResultOfSizeWordApplication) =
        matchersWrapper.or(matchers.not.apply(matchers.have.size(resultOfSizeWordApplication.expectedSize)))

      /**
       * This method enables the following syntax:
       *
       *        * book should (not have (title ("Moby Dick")) or not have (author ("Melville")))
       *                                                    ^
       * 
       */
      def have[T](firstPropertyMatcher: HavePropertyMatcher[T, _], propertyMatchers: HavePropertyMatcher[T, _]*) =
        matchersWrapper.or(matchers.not.apply(matchers.have(firstPropertyMatcher, propertyMatchers: _*)))

      /**
       * This method enables the following syntax:
       *
       *        * map should (contain key (7) or not be (null))
       *                                    ^
       * 
       */
      def be[T](o: Null) = matchersWrapper.or(matchers.not.be(o))

      /**
       * This method enables the following syntax:
       *
       *        * 5 should (not be < (7) or not be < (8))
       *                               ^
       * 
       */
      def be[T](resultOfLessThanComparison: ResultOfLessThanComparison[T]) =
        matchersWrapper.or(matchers.not.be(resultOfLessThanComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 7 should (not be > (5) or not be > (6))
       *                               ^
       * 
       */
      def be[T](resultOfGreaterThanComparison: ResultOfGreaterThanComparison[T]) =
        matchersWrapper.or(matchers.not.be(resultOfGreaterThanComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 2 should (not be <= (3) or not be <= (2))
       *                                ^
       * 
       */
      def be[T](resultOfLessThanOrEqualToComparison: ResultOfLessThanOrEqualToComparison[T]) =
        matchersWrapper.or(matchers.not.be(resultOfLessThanOrEqualToComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 8 should (not be >= (7) or not be >= (6))
       *                                ^
       * 
       */
      def be[T](resultOfGreaterThanOrEqualToComparison: ResultOfGreaterThanOrEqualToComparison[T]) =
        matchersWrapper.or(matchers.not.be(resultOfGreaterThanOrEqualToComparison))

      /**
       * This method enables the following syntax:
       *
       *        * 5 should (not be === (7) or not be === (8))
       *                                 ^
       * 
       */
      def be(resultOfTripleEqualsApplication: ResultOfTripleEqualsApplication) =
        matchersWrapper.or(matchers.not.be(resultOfTripleEqualsApplication))

      /**
       * This method enables the following syntax:
       *
       *        * notEmptyMock should (not be ('full) or not be ('empty))
       *                                            ^
       * 
       */
      def be(symbol: Symbol) = matchersWrapper.or(matchers.not.be(symbol))

      /**
       * This method enables the following syntax:
       *
       *        * 2 should (not be (even) or not be (odd))
       *                                ^
       * 
       */
      def be[T](beMatcher: BeMatcher[T]) = matchersWrapper.or(matchers.not.be(beMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (not be (directory) or not be (file))
       *                                          ^
       * 
       */
      def be[T](bePropertyMatcher: BePropertyMatcher[T]) = matchersWrapper.or(matchers.not.be(bePropertyMatcher))

      /**
       * This method enables the following syntax:
       *
       *        * isNotFileMock should (not be a ('directory) or not be a ('file))
       *                                                    ^
       * 
       */
      def be[T](resultOfAWordApplication: ResultOfAWordToSymbolApplication) = matchersWrapper.or(matchers.not.be(resultOfAWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (not be a (directory) or not be a (file))
       *                                            ^
       * 
       */
      def be[T <: AnyRef](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[T]) = matchersWrapper.or(matchers.not.be(resultOfAWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * notAppleMock should (not be an ('apple) or not be an ('apple))
       *                                                ^
       * 
       */
      def be[T](resultOfAnWordApplication: ResultOfAnWordToSymbolApplication) = matchersWrapper.or(matchers.not.be(resultOfAnWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * myFile should (not be an (directory) or not be an (file))
       *                                             ^
       * 
       */
      def be[T <: AnyRef](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[T]) = matchersWrapper.or(matchers.not.be(resultOfAnWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * obj should (not be theSameInstanceAs (otherString) or not be theSameInstanceAs (string))
       *                                                           ^
       * 
       */
      def be[T](resultOfTheSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication) = matchersWrapper.or(matchers.not.be(resultOfTheSameInstanceAsApplication))

      /**
       * This method enables the following syntax:
       *
       *        * sevenDotOh should (not be (17.0 plusOrMinus 0.2) or not be (17.0 plusOrMinus 0.2))
       *                                                         ^
       * 
       */
      def be(doubleTolerance: DoubleTolerance) = matchersWrapper.or(matchers.not.be(doubleTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenDotOhFloat should (not be (17.0f plusOrMinus 0.2f) or not be (17.0f plusOrMinus 0.2f))
       *                                                                ^
       * 
       */
      def be(floatTolerance: FloatTolerance) = matchersWrapper.or(matchers.not.be(floatTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenLong should (not be (17L plusOrMinus 2L) or not be (17L plusOrMinus 2L))
       *                                                      ^
       * 
       */
      def be(longTolerance: LongTolerance) = matchersWrapper.or(matchers.not.be(longTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenInt should (not be (17 plusOrMinus 2) or not be (17 plusOrMinus 2))
       *                                                   ^
       * 
       */
      def be(intTolerance: IntTolerance) = matchersWrapper.or(matchers.not.be(intTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenShort should (not be (17.toShort plusOrMinus 2.toShort) or not be (17.toShort plusOrMinus 2.toShort))
       *                                                                     ^
       * 
       */
      def be(shortTolerance: ShortTolerance) = matchersWrapper.or(matchers.not.be(shortTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * sevenByte should ((not be (19.toByte plusOrMinus 2.toByte)) or (not be (19.toByte plusOrMinus 2.toByte)))
       *                                                                     ^
       * 
       */
      def be(byteTolerance: ByteTolerance) = matchersWrapper.or(matchers.not.be(byteTolerance))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not fullyMatch regex ("fred") or not fullyMatch regex (decimal))
       *                                                     ^
       * 
       */
      def fullyMatch(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.or(matchers.not.fullyMatch(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not include regex ("fred") or not include regex (decimal))
       *                                                  ^
       * 
       */
      def include(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.or(matchers.not.include(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not include ("bob") or not include ("1.7"))
       *                                           ^
       * 
       */
      def include(expectedSubstring: String) =
        matchersWrapper.or(matchers.not.include(expectedSubstring))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not startWith regex ("bob") or not startWith regex (decimal))
       *                                                   ^
       * 
       */
      def startWith(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.or(matchers.not.startWith(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not startWith ("fred") or not startWith ("1.7"))
       *                                              ^
       * 
       */
      def startWith(expectedSubstring: String) =
        matchersWrapper.or(matchers.not.startWith(expectedSubstring))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not endWith regex ("bob") or not endWith regex (decimal))
       *                                                 ^
       * 
       */
      def endWith(resultOfRegexWordApplication: ResultOfRegexWordApplication) =
        matchersWrapper.or(matchers.not.endWith(resultOfRegexWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * "fred" should (not endWith ("fred") or not endWith ("1.7"))
       *                                            ^
       * 
       */
      def endWith(expectedSubstring: String) =
        matchersWrapper.or(matchers.not.endWith(expectedSubstring))

      /**
       * This method enables the following syntax:
       *
       *        * Array(1, 2) should (not contain (1) or not contain (3))
       *                                            ^
       * 
       */
      def contain[T](expectedElement: T) =
        matchersWrapper.or(matchers.not.contain(expectedElement))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (not contain key ("two") or not contain key ("three"))
       *                                                                    ^
       * 
       */
      def contain[T](resultOfKeyWordApplication: ResultOfKeyWordApplication[T]) =
        matchersWrapper.or(matchers.not.contain(resultOfKeyWordApplication))

      /**
       * This method enables the following syntax:
       *
       *        * Map("one" -> 1, "two" -> 2) should (not contain value (2) or not contain value (3))
       *                                                                  ^
       * 
       */
      def contain[T](resultOfValueWordApplication: ResultOfValueWordApplication[T]) =
        matchersWrapper.or(matchers.not.contain(resultOfValueWordApplication))
    }

    /**
     * This method enables the following syntax:
     *
     *      * Map("one" -> 1, "two" -> 2) should (not contain value (2) or not contain value (3))
     *                                                           ^
     * 
     */
    def or(notWord: NotWord): OrNotWord = new OrNotWord
  }

  /**
   * This implicit conversion method enables ScalaTest matchers expressions that involve and and or.
   */
  implicit def convertToMatcherWrapper[T](leftMatcher: Matcher[T]): MatcherWrapper[T] = new MatcherWrapper(leftMatcher)

  //
  // This class is used as the return type of the overloaded should method (in MapShouldWrapper)
  // that takes a HaveWord. It's key method will be called in situations like this:
  //
  // map should have key 1
  //
  // This gets changed to :
  //
  // convertToMapShouldWrapper(map).should(have).key(1)
  //
  // Thus, the map is wrapped in a convertToMapShouldWrapper call via an implicit conversion, which results in
  // a MapShouldWrapper. This has a should method that takes a HaveWord. That method returns a
  // ResultOfHaveWordPassedToShould that remembers the map to the left of should. Then this class
  // ha a key method that takes a K type, they key type of the map. It does the assertion thing.
  // 
  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfContainWordForMap[K, V](left: scala.collection.Map[K, V], shouldBeTrue: Boolean) {
  // class ResultOfContainWordForMap[K, V](left: scala.collection.Map[K, V], shouldBeTrue: Boolean) extends ResultOfContainWordForIterable[Tuple2[K, V]](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * map should contain key ("one")
     *                    ^
     * 
     */
    def key(expectedKey: K) {
      if (left.contains(expectedKey) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainKey" else "containedKey",
            left,
            expectedKey)
        )
    }

    /**
     * This method enables the following syntax:
     *
     *      * map should contain value (1)
     *                    ^
     * 
     */
    def value(expectedValue: V) {
      // if (left.values.contains(expectedValue) != shouldBeTrue) CHANGING FOR 2.8.0 RC1
      if (left.values.exists(expectedValue == _) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainValue" else "containedValue",
            left,
            expectedValue)
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfContainWordForJavaMap[K, V](left: java.util.Map[K, V], shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax (javaMap is a java.util.Map):
     *
     *      * javaMap should contain key ("two")
     *                        ^
     * 
     */
    def key(expectedKey: K) {
      if (left.containsKey(expectedKey) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainKey" else "containedKey",
            left,
            expectedKey)
        )
    }

    /**
     * This method enables the following syntax (javaMap is a java.util.Map):
     *
     *      * javaMap should contain value ("2")
     *                        ^
     * 
     */
    def value(expectedValue: V) {
      if (left.containsValue(expectedValue) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainValue" else "containedValue",
            left,
            expectedValue)
        )
    }
  }

  /**
   * This implicit conversion method enables the following syntax (javaColl is a java.util.Collection):
   *
   *    * javaColl should contain ("two")
   * 
   *
   * The (contain element ("two")) expression will result in a Matcher[scala.Iterable[String]]. This
   * implicit conversion method will convert that matcher to a Matcher[java.util.Collection[String]].
   */
  implicit def convertIterableMatcherToJavaCollectionMatcher[T](iterableMatcher: Matcher[Iterable[T]]) = 
    new Matcher[java.util.Collection[T]] {
      def apply(left: java.util.Collection[T]) = {
        val iterable = new Iterable[T] {
          override def iterator = new Iterator[T] { // For 2.8
          // def elements = new Iterator[T] { // For 2.7
            private val javaIterator = left.iterator
            def next: T = javaIterator.next
            def hasNext: Boolean = javaIterator.hasNext
          }
          override def toString = left.toString
        }
        iterableMatcher.apply(iterable)
      }
    }

  // XXX
  implicit def convertIterableMatcherToArraytMatcher[T](iterableMatcher: Matcher[Iterable[T]]) =
    new Matcher[Array[T]] {
      def apply(left: Array[T]) = {
        val iterable = new Iterable[T] {
          override def iterator = new Iterator[T] { // For 2.8
            private var index = 0
            def hasNext: Boolean = index < left.length
            def next: T = {
              index += 1
              left(index - 1)
            }
          }
          // Need to prettify the array's toString, because by the time it gets to decorateToStringValue, the array
          // has been wrapped in this Iterable and so it won't get prettified anymore by FailureMessages.decorateToStringValue.
          override def toString = FailureMessages.prettifyArrays(left).toString
        }
        iterableMatcher.apply(iterable)
      }
    }

  /**
   * This implicit conversion method enables the following syntax (javaMap is a java.util.Map):
   *
   *    * javaMap should (contain key ("two"))
   * 
   *
   * The (contain key ("two")) expression will result in a Matcher[scala.collection.Map[String, Any]]. This
   * implicit conversion method will convert that matcher to a Matcher[java.util.Map[String, Any]].
   */
  implicit def convertMapMatcherToJavaMapMatcher[K, V](mapMatcher: Matcher[scala.collection.Map[K, V]]) = 
    new Matcher[java.util.Map[K, V]] {
      def apply(left: java.util.Map[K, V]) = {
        // Even though the java map is mutable I just wrap it it to a plain old Scala map, because
        // I have no intention of mutating it.
        class MapWrapper[Z](javaMap: java.util.Map[K, Z]) extends scala.collection.Map[K, Z] {
          override def size: Int = javaMap.size
          def get(key: K): Option[Z] =
            if (javaMap.containsKey(key)) Some(javaMap.get(key)) else None
          override def iterator = new Iterator[(K, Z)] {
            private val javaIterator = javaMap.keySet.iterator
            def next: (K, Z) = {
              val nextKey = javaIterator.next
              (nextKey, javaMap.get(nextKey))
            }
            def hasNext: Boolean = javaIterator.hasNext
          }
          override def +[W >: Z] (kv: (K, W)): scala.collection.Map[K, W] = {
            val newJavaMap = new java.util.HashMap[K, W](javaMap)
            val (key, value) = kv
            newJavaMap.put(key, value)
            new MapWrapper[W](newJavaMap)
          }
          override def - (key: K): scala.collection.Map[K, Z] = {
            val newJavaMap = new java.util.HashMap[K, Z](javaMap)
            newJavaMap.remove(key)
            new MapWrapper[Z](newJavaMap)
          }
          override def toString = javaMap.toString
        }
        val scalaMap = new MapWrapper[V](left)
        mapMatcher.apply(scalaMap)
      }
    }

  // Ack. The above conversion doesn't apply to java.util.Maps, because java.util.Map is not a subinterface
  // of java.util.Collection. But right now Matcher[Iterable] supports only "contain" and "have size"
  // syntax, and thus that should work on Java maps too, why not. Well I'll tell you why not. It is too complicated.
  // Since java Map is not a java Collection, I'll say the contain syntax doesn't work on it. But you can say
  // have key.

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ContainWord {

    /**
     * This method enables the following syntax:
     *
     *      * Array(1, 2) should (contain (2) and contain (1))
     *                             ^
     * 
     */
    def apply[T](expectedElement: T): Matcher[Iterable[T]] =
      new Matcher[Iterable[T]] {
        def apply(left: Iterable[T]) =
          MatchResult(
            left.iterator.contains(expectedElement), 
            FailureMessages("didNotContainExpectedElement", left, expectedElement),
            FailureMessages("containedExpectedElement", left, expectedElement)
          )
      }

    //
    // This key method is called when "contain" is used in a logical expression, such as:
    // map should { contain key 1 and equal (Map(1 -> "Howdy")) }. It results in a matcher
    // that remembers the key value. By making the value type Any, it causes overloaded shoulds
    // to work, because for example a Matcher[Map[Int, Any]] is a subtype of Matcher[Map[Int, String]],
    // given Map is covariant in its V (the value type stored in the map) parameter and Matcher is
    // contravariant in its lone type parameter. Thus, the type of the Matcher resulting from contain key 1
    // is a subtype of the map type that has a known value type parameter because its that of the map
    // to the left of should. This means the should method that takes a map will be selected by Scala's
    // method overloading rules.
    //
    /**
     * This method enables the following syntax:
     *
     *      * map should (contain key ("fifty five") or contain key ("twenty two"))
     *                     ^
     * 
     *
     * The map's value type parameter cannot be inferred because only a key type is provided in
     * an expression like (contain key ("fifty five")). The matcher returned
     * by this method matches scala.collection.Maps with the inferred key type and value type Any. Given
     * Map is covariant in its value type, and Matcher is contravariant in
     * its type parameter, a Matcher[Map[Int, Any]], for example, is a subtype of Matcher[Map[Int, String]].
     * This will enable the matcher returned by this method to be used against any Map that has
     * the inferred key type.
     */
    def key[K](expectedKey: K): Matcher[scala.collection.Map[K, Any]] =
      new Matcher[scala.collection.Map[K, Any]] {
        def apply(left: scala.collection.Map[K, Any]) =
          MatchResult(
            left.contains(expectedKey),
            FailureMessages("didNotContainKey", left, expectedKey),
            FailureMessages("containedKey", left, expectedKey)
          )
      }

    // Holy smokes I'm starting to scare myself. I fixed the problem of the compiler not being
    // able to infer the value type in contain value 1 and ... like expressions, because the
    // value type is there, with an existential type. Since I don't know what K is, I decided to
    // try just saying that with an existential type, and it compiled and ran. Pretty darned
    // amazing compiler. The problem could not be fixed like I fixed the key method above, because
    // Maps are nonvariant in their key type parameter, whereas they are covariant in their value
    // type parameter, so the same trick wouldn't work. But this existential type trick seems to
    // work like a charm.
    /**
     * This method enables the following syntax:
     *
     *      * Map("one" -> 1, "two" -> 2) should (not contain value (5) and not contain value (3))
     *                                                 ^
     * 
     *
     * The map's key type parameter cannot be inferred because only a value type is provided in
     * an expression like (contain value (5)). The matcher returned
     * by this method matches scala.collection.Maps with the inferred value type and the existential key
     * type [K] forSome { type K }. Even though Matcher is contravariant in its type parameter, because
     * Map is nonvariant in its key type, 
     * a Matcher[Map[Any, Int]], for example, is not a subtype of Matcher[Map[String, Int]],
     * so the key type parameter of the Map returned by this method cannot be Any. By making it
     * an existential type, the Scala compiler will not infer it to anything more specific.
     * This will enable the matcher returned by this method to be used against any Map that has
     * the inferred value type.
     *
     */
    def value[V](expectedValue: V): Matcher[scala.collection.Map[K, V] forSome { type K }] =
      new Matcher[scala.collection.Map[K, V] forSome { type K }] {
        def apply(left: scala.collection.Map[K, V] forSome { type K }) =
          MatchResult(
            // left.values.contains(expectedValue), CHANGING FOR 2.8.0 RC1
            left.values.exists(expectedValue == _),
            FailureMessages("didNotContainValue", left, expectedValue),
            FailureMessages("containedValue", left, expectedValue)
          )
      }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class IncludeWord {

    /**
     * This method enables the following syntax:
     *
     *      * "1.7" should (include ("1.7") and include ("1.8"))
     *                       ^
     * 
     */
    def apply(expectedSubstring: String): Matcher[String] =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            left.indexOf(expectedSubstring) >= 0, 
            FailureMessages("didNotIncludeSubstring", left, expectedSubstring),
            FailureMessages("includedSubstring", left, expectedSubstring)
          )
      }

    /**
     * This method enables the following syntax:
     *
     *      * val decimal = """(-)?(\d+)(\.\d*)?"""
     * "a1.7b" should (include regex (decimal) and include regex (decimal))
     *                         ^
     * 
     */
    def regex[T <: String](right: T): Matcher[T] = regex(right.r)

    /**
     * This method enables the following syntax:
     *
     *      * val decimalRegex = """(-)?(\d+)(\.\d*)?""".r
     * "a1.7" should (include regex (decimalRegex) and include regex (decimalRegex))
     *                        ^
     * 
     */
    def regex(expectedRegex: Regex): Matcher[String] =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            expectedRegex.findFirstIn(left).isDefined,
            FailureMessages("didNotIncludeRegex", left, expectedRegex),
            FailureMessages("includedRegex", left, expectedRegex)
          )
      }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class StartWithWord {

    /**
     * This method enables the following syntax:
     *
     *      * "1.7b" should (startWith ("1.7") and startWith ("1.7b"))
     *                          ^
     * 
     */
    def apply(right: String) =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            left startsWith right,
            FailureMessages("didNotStartWith", left, right),
            FailureMessages("startedWith", left, right)
          )
      }

    /**
     * This method enables the following syntax:
     *
     *      * val decimal = """(-)?(\d+)(\.\d*)?"""
     * "1.7b" should (startWith regex (decimal) and startWith regex (decimal))
     *                          ^
     * 
     */
    def regex[T <: String](right: T): Matcher[T] = regex(right.r)

    /**
     * This method enables the following syntax:
     *
     *      * val decimalRegex = """(-)?(\d+)(\.\d*)?""".r
     * "1.7" should (startWith regex (decimalRegex) and startWith regex (decimalRegex))
     *                         ^
     * 
     */
    def regex(rightRegex: Regex): Matcher[String] =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            rightRegex.pattern.matcher(left).lookingAt,
            FailureMessages("didNotStartWithRegex", left, rightRegex),
            FailureMessages("startedWithRegex", left, rightRegex)
          )
      }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class EndWithWord {

    /**
     * This method enables the following syntax:
     *
     *      * "1.7b" should (endWith ("1.7b") and endWith ("7b"))
     *                        ^
     * 
     */
    def apply(right: String) =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            left endsWith right,
            FailureMessages("didNotEndWith", left, right),
            FailureMessages("endedWith", left, right)
          )
      }

    /**
     * This method enables the following syntax:
     *
     *      * val decimal = """(-)?(\d+)(\.\d*)?"""
     * "b1.7" should (endWith regex (decimal) and endWith regex (decimal))
     *                        ^
     * 
     */
    def regex[T <: String](right: T): Matcher[T] = regex(right.r)

    /**
     * This method enables the following syntax:
     *
     *      * val decimalRegex = """(-)?(\d+)(\.\d*)?""".r
     * "b1.7" should (endWith regex (decimalRegex) and endWith regex (decimalRegex))
     *                        ^
     * 
     */
    def regex(rightRegex: Regex): Matcher[String] =
      new Matcher[String] {
        def apply(left: String) = {
          val allMatches = rightRegex.findAllIn(left)
          MatchResult(
            allMatches.hasNext && (allMatches.end == left.length),
            FailureMessages("didNotEndWithRegex", left, rightRegex),
            FailureMessages("endedWithRegex", left, rightRegex)
          )
        }
      }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class FullyMatchWord {

    /**
     * This method enables the following syntax:
     *
     *      * val decimal = """(-)?(\d+)(\.\d*)?"""
     * "1.7" should (fullyMatch regex (decimal) and fullyMatch regex (decimal))
     *                          ^
     * 
     */
    def regex(rightRegexString: String): Matcher[String] =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            java.util.regex.Pattern.matches(rightRegexString, left),
            FailureMessages("didNotFullyMatchRegex", left, UnquotedString(rightRegexString)),
            FailureMessages("fullyMatchedRegex", left, UnquotedString(rightRegexString))
          )
      }

    /**
     * This method enables the following syntax:
     *
     *      * val decimalRegex = """(-)?(\d+)(\.\d*)?""".r
     * "1.7" should (fullyMatch regex (decimalRegex) and fullyMatch regex (decimalRegex))
     *                          ^
     * 
     */
    def regex(rightRegex: Regex): Matcher[String] =
      new Matcher[String] {
        def apply(left: String) =
          MatchResult(
            rightRegex.pattern.matcher(left).matches,
            FailureMessages("didNotFullyMatchRegex", left, rightRegex),
            FailureMessages("fullyMatchedRegex", left, rightRegex)
          )
      }
  }

// The getLength and getSize field conversions seem inconsistent with
// what I do in symbol HavePropertyMatchers. It isn't, though because the difference is here
// it's a Scala field and there a Java field: a val getLength is a 
// perfectly valid Scala way to get a JavaBean property Java method in the bytecodes.

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * 
   * Subclasses of this abstract class are used as the result of implicit conversions from the various structural types that
   * are considered to represent length: length or getLength methods or fields that return Int
   * or Long. This enables the have length (7) syntax to be used with any object that has a length.
   * The implicit conversion methods that result in this type are:
   * 
   *
   * 
   * convertLengthFieldToIntLengthWrapper
   * convertLengthMethodToIntLengthWrapper
   * convertGetLengthFieldToIntLengthWrapper
   * convertGetLengthMethodToIntLengthWrapper
   * convertLengthFieldToLongLengthWrapper
   * convertLengthFieldToLongLengthWrapper
   * convertGetLengthFieldToLongLengthWrapper
   * convertGetLengthMethodToLongLengthWrapper
   * 
   *
   * @author Bill Venners
   */
  abstract class LengthWrapper {
    def length: Long
  }

  /**
   * This implicit conversion method converts an object with a length field of type Int to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertLengthFieldToIntLengthWrapper(o: { val length: Int }) =
    new LengthWrapper {
      def length = o.length
    }

  /**
   * This implicit conversion method converts an object with a length method of type Int to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertLengthMethodToIntLengthWrapper(o: { def length(): Int }) =
    new LengthWrapper {
      def length = o.length()
    }

  /**
   * This implicit conversion method converts an object with a getLength field of type Int to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertGetLengthFieldToIntLengthWrapper(o: { val getLength: Int }) =
    new LengthWrapper {
      def length = o.getLength
    }

  /**
   * This implicit conversion method converts an object with a getLength method of type Int to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertGetLengthMethodToIntLengthWrapper(o: { def getLength(): Int }) =
    new LengthWrapper {
      def length = o.getLength()
    }

  /**
   * This implicit conversion method converts an object with a length field of type Long to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertLengthFieldToLongLengthWrapper(o: { val length: Long }) =
    new LengthWrapper {
      def length = o.length
    }

  /**
   * This implicit conversion method converts an object with a length method of type Long to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertLengthMethodToLongLengthWrapper(o: { def length(): Long }) =
    new LengthWrapper {
      def length = o.length()
    }

  /**
   * This implicit conversion method converts an object with a getLength field of type Long to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertGetLengthFieldToLongLengthWrapper(o: { val getLength: Long }) =
    new LengthWrapper {
      def length = o.getLength
    }

  /**
   * This implicit conversion method converts an object with a getLength method of type Long to a
   * LengthWrapper, to enable that object to be used with the have length (7) syntax.
   */
  implicit def convertGetLengthMethodToLongLengthWrapper(o: { def getLength(): Long }) =
    new LengthWrapper {
      def length = o.getLength()
    }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * 
   * Subclasses of this abstract class are used as the result of implicit conversions from the various structural types that
   * are considered to represent size: size or getSize methods or fields that return Int
   * or Long. This enables the have size (7) syntax to be used with any object that has a size.
   * The implicit conversion methods that result in this type are:
   * 
   *
   * 
   * convertSizeFieldToIntSizeWrapper
   * convertSizeMethodToIntSizeWrapper
   * convertGetSizeFieldToIntSizeWrapper
   * convertGetSizeMethodToIntSizeWrapper
   * convertSizeFieldToLongSizeWrapper
   * convertSizeFieldToLongSizeWrapper
   * convertGetSizeFieldToLongSizeWrapper
   * convertGetSizeMethodToLongSizeWrapper
   * 
   *
   * @author Bill Venners
   */
  abstract class SizeWrapper {
    def size: Long
  }

  /**
   * This implicit conversion method converts an object with a size field of type Int to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertSizeFieldToIntSizeWrapper(o: { val size: Int }) =
    new SizeWrapper {
      def size = o.size
    }

  /**
   * This implicit conversion method converts an object with a size method of type Int to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertSizeMethodToIntSizeWrapper(o: { def size(): Int }) =
    new SizeWrapper {
      def size = o.size()
    }

  /**
   * This implicit conversion method converts an object with a getSize field of type Int to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertGetSizeFieldToIntSizeWrapper(o: { val getSize: Int }) =
    new SizeWrapper {
      def size = o.getSize
    }

  /**
   * This implicit conversion method converts an object with a getSize method of type Int to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertGetSizeMethodToIntSizeWrapper(o: { def getSize(): Int }) =
    new SizeWrapper {
      def size = o.getSize()
    }

  /**
   * This implicit conversion method converts an object with a size field of type Long to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertSizeFieldToLongSizeWrapper(o: { val size: Long }) =
    new SizeWrapper {
      def size = o.size
    }

  /**
   * This implicit conversion method converts an object with a size method of type Long to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertSizeMethodToLongSizeWrapper(o: { def size(): Long }) =
    new SizeWrapper {
      def size = o.size()
    }

  /**
   * This implicit conversion method converts an object with a getSize field of type Long to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertGetSizeFieldToLongSizeWrapper(o: { val getSize: Long }) =
    new SizeWrapper {
      def size = o.getSize
    }

  /**
   * This implicit conversion method converts an object with a getSize method of type Long to a
   * LengthWrapper, to enable that object to be used with the have size (7) syntax.
   */
  implicit def convertGetSizeMethodToLongSizeWrapper(o: { def getSize(): Long }) =
    new SizeWrapper {
      def size = o.getSize()
    }
 
  // This guy is generally done through an implicit conversion from a symbol. It takes that symbol, and 
  // then represents an object with an apply method. So it gives an apply method to symbols.
  // book should have ('author ("Gibson"))
  //                   ^ // Basically this 'author symbol gets converted into this class, and its apply  method takes "Gibson"
  // TODO, put the documentation of the details of the algo for selecting a method or field to use here.
  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * 
   * This class is used as the result of an implicit conversion from class Symbol, to enable symbols to be
   * used in have ('author ("Dickens")) syntax. The name of the implicit conversion method is
   * convertSymbolToHavePropertyMatcherGenerator.
   * 
   *
   * 
   * Class HavePropertyMatcherGenerator's primary constructor takes a Symbol. The 
   * apply method uses reflection to find and access a property that has the name specified by the
   * Symbol passed to the constructor, so it can determine if the property has the expected value
   * passed to apply.
   * If the symbol passed is 'title, for example, the apply method
   * will use reflection to look for a public Java field named
   * "title", a public method named "title", or a public method named "getTitle". 
   * If a method, it must take no parameters. If multiple candidates are found,
   * the apply method will select based on the following algorithm:
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * Field Method "get" Method Result
      Throws TestFailedException, because no candidates found
    getTitle() Invokes getTitle()
  title()   Invokes title()
  title() getTitle() Invokes title() (this can occur when BeanProperty annotation is used)
title     Accesses field title
title   getTitle() Invokes getTitle()
title title()   Invokes title()
title title() getTitle() Invokes title() (this can occur when BeanProperty annotation is used)
   * 
   *
   * @author Bill Venners
   */
  final class HavePropertyMatcherGenerator(symbol: Symbol) {

    /**
     * This method enables the following syntax:
     *
     *      * book should have ('title ("A Tale of Two Cities"))
     *                          ^
     * 
     * 
     * 
     * This class has an apply method that will produce a HavePropertyMatcher[AnyRef, Any].
     * The implicit conversion method, convertSymbolToHavePropertyMatcherGenerator, will cause the 
     * above line of code to be eventually transformed into:
     * 
     * 
     *      * book should have (convertSymbolToHavePropertyMatcherGenerator('title).apply("A Tale of Two Cities"))
     * 
     */
    def apply(expectedValue: Any) =
      new HavePropertyMatcher[AnyRef, Any] {

        /**
         * This method enables the following syntax:
         *
         *          * book should have ('title ("A Tale of Two Cities"))
         * 
         * 
         * 
         * This method uses reflection to discover a field or method with a name that indicates it represents
         * the value of the property with the name contained in the Symbol passed to the 
         * HavePropertyMatcherGenerator's constructor. The field or method must be public. To be a
         * candidate, a field must have the name symbol.name, so if symbol is 'title,
         * the field name sought will be "title". To be a candidate, a method must either have the name
         * symbol.name, or have a JavaBean-style get or is. If the type of the
         * passed expectedValue is Boolean, "is" is prepended, else "get"
         * is prepended. Thus if 'title is passed as symbol, and the type of the expectedValue is
         * String, a method named getTitle will be considered a candidate (the return type
         * of getTitle will not be checked, so it need not be String. By contrast, if 'defined
         * is passed as symbol, and the type of the expectedValue is Boolean, a method
         * named isTitle will be considered a candidate so long as its return type is Boolean.
         * 
         * TODO continue the story
         */
        def apply(objectWithProperty: AnyRef): HavePropertyMatchResult[Any] = {

          // If 'empty passed, propertyName would be "empty"
          val propertyName = symbol.name

          val isBooleanProperty =
            expectedValue match {
              case o: Boolean => true
              case _ => false
            }

          accessProperty(objectWithProperty, symbol, isBooleanProperty) match {

            case None =>

              // if propertyName is '>, mangledPropertyName would be "$greater"
              val mangledPropertyName = transformOperatorChars(propertyName)

              // methodNameToInvoke would also be "title"
              val methodNameToInvoke = mangledPropertyName

              // methodNameToInvokeWithGet would be "getTitle"
              val methodNameToInvokeWithGet = "get"+ mangledPropertyName(0).toUpper + mangledPropertyName.substring(1)

              throw newTestFailedException(Resources("propertyNotFound", methodNameToInvoke, expectedValue.toString, methodNameToInvokeWithGet))

            case Some(result) =>

              new HavePropertyMatchResult[Any](
                result == expectedValue,
                propertyName,
                expectedValue,
                result
              )
          }
        }
      }
  }

  /**
   * This implicit conversion method converts a Symbol to a
   * HavePropertyMatcherGenerator, to enable the symbol to be used with the have ('author ("Dickens")) syntax.
   */
  implicit def convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol) = new HavePropertyMatcherGenerator(symbol)

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class HaveWord {

    // TODO: How about returning a Matcher[Gazornimplatz] and then providing implicit conversion
    // methods from Matcher[Gazornimplatz] to Matcher[Seq], Matcher[String], Matcher[java.util.List], and
    // Matcher[the structural length methods]. This is similar to the technique I used with "contain (7)"
    // to get it to work with java.util.Collection.
    // I couldn't figure out how to combine view bounds with existential types. May or may not
    // be possible, but going dynamic for now at least.
    /**
     * This method enables the following syntax:
     *
     *      * book should have length (9)
     *                  ^
     * 
     *
     * 
     * Currently (as of ScalaTest 0.9.5), this method will produce a Matcher[AnyRef], and if the
     * AnyRef passed to that matcher's apply method does not have the appropriate length property
     * structure, all will compile but a TestFailedException will result at runtime explaining the problem. The one exception is that it will work on
     * java.util.List, even though that type has no length structure (its size property
     * will be used instead.) In a future ScalaTest release, this may be tightened so that all is statically checked at compile time.
     * 
     */
    def length(expectedLength: Long) =
      new Matcher[AnyRef] {
        def apply(left: AnyRef) =
          left match {
            case leftArray: Array[_] =>
              MatchResult(
                leftArray.length == expectedLength, 
                FailureMessages("didNotHaveExpectedLength", left, expectedLength),
                FailureMessages("hadExpectedLength", left, expectedLength)
              )
            case leftSeq: Seq[_] =>
              MatchResult(
                leftSeq.length == expectedLength, 
                FailureMessages("didNotHaveExpectedLength", left, expectedLength),
                FailureMessages("hadExpectedLength", left, expectedLength)
              )
            case leftString: String =>
              MatchResult(
                leftString.length == expectedLength, 
                FailureMessages("didNotHaveExpectedLength", left, expectedLength),
                FailureMessages("hadExpectedLength", left, expectedLength)
              )
            case leftJavaList: java.util.List[_] =>
              MatchResult(
                leftJavaList.size == expectedLength,
                FailureMessages("didNotHaveExpectedLength", left, expectedLength),
                FailureMessages("hadExpectedLength", left, expectedLength)
              )
            case _ =>

              accessProperty(left, 'length, false) match {

                case None =>

                  throw newTestFailedException(Resources("noLengthStructure", expectedLength.toString))

                case Some(result) =>

                  MatchResult(
                    result == expectedLength,
                    FailureMessages("didNotHaveExpectedLength", left, expectedLength),
                    FailureMessages("hadExpectedLength", left, expectedLength)
                  )
              }
          }
      }

    /**
     * This method enables the following syntax:
     *
     *      * book should have size (9)
     *                  ^
     * 
     *
     * 
     * Currently (as of ScalaTest 0.9.5), this method will produce a Matcher[AnyRef], and if the
     * AnyRef passed to that matcher's apply method does not have the appropriate size property
     * structure, all will compile but a TestFailedException will result at runtime explaining the problem.
     * In a future ScalaTest release, this may be tightened so that all is statically checked at compile time.
     * 
     */
    def size(expectedSize: Long) =
      new Matcher[AnyRef] {
        def apply(left: AnyRef) =
          left match {
            case leftArray: Array[_] =>
              MatchResult(
                leftArray.length == expectedSize, 
                FailureMessages("didNotHaveExpectedSize", left, expectedSize),
                FailureMessages("hadExpectedSize", left, expectedSize)
              )
            case leftSeq: Collection[_] =>
              MatchResult(
                leftSeq.size == expectedSize, 
                FailureMessages("didNotHaveExpectedSize", left, expectedSize),
                FailureMessages("hadExpectedSize", left, expectedSize)
              )
            case leftJavaList: java.util.List[_] =>
              MatchResult(
                leftJavaList.size == expectedSize,
                FailureMessages("didNotHaveExpectedSize", left, expectedSize),
                FailureMessages("hadExpectedSize", left, expectedSize)
              )
            case _ =>

              accessProperty(left, 'size, false) match {

                case None =>

                  throw newTestFailedException(Resources("noSizeStructure", expectedSize.toString))

                case Some(result) =>

                  MatchResult(
                    result == expectedSize,
                    FailureMessages("didNotHaveExpectedSize", left, expectedSize),
                    FailureMessages("hadExpectedSize", left, expectedSize)
                  )
              }
          }
      }

    /**
     * This method enables the following syntax:
     *
     *      * book should have (title ("A Tale of Two Cities"))
     *                  ^
     * 
     */
    def apply[T](firstPropertyMatcher: HavePropertyMatcher[T, _], propertyMatchers: HavePropertyMatcher[T, _]*): Matcher[T] =

      new Matcher[T] {

        def apply(left: T) = {

          val results =
            for (propertyVerifier <- firstPropertyMatcher :: propertyMatchers.toList) yield
              propertyVerifier(left)

          val firstFailureOption = results.find(pv => !pv.matches)

          val justOneProperty = propertyMatchers.length == 0

          firstFailureOption match {

            case Some(firstFailure) =>

              val failedVerification = firstFailure
              val failureMessage =
                FailureMessages(
                  "propertyDidNotHaveExpectedValue",
                  UnquotedString(failedVerification.propertyName),
                  failedVerification.expectedValue,
                  failedVerification.actualValue,
                  left
                )
              val midSentenceFailureMessage =
                FailureMessages(
                  "midSentencePropertyDidNotHaveExpectedValue",
                  UnquotedString(failedVerification.propertyName),
                  failedVerification.expectedValue,
                  failedVerification.actualValue,
                  left
                )

              MatchResult(false, failureMessage, failureMessage, midSentenceFailureMessage, midSentenceFailureMessage)

            case None =>

              val failureMessage =
                if (justOneProperty) {
                  val firstPropertyResult = results.head // know this will succeed, because firstPropertyMatcher was required
                  FailureMessages(
                    "propertyHadExpectedValue",
                    UnquotedString(firstPropertyResult.propertyName),
                    firstPropertyResult.expectedValue,
                    left
                  )
                }
                else FailureMessages("allPropertiesHadExpectedValues", left)

              val midSentenceFailureMessage =
                if (justOneProperty) {
                  val firstPropertyResult = results.head // know this will succeed, because firstPropertyMatcher was required
                  FailureMessages(
                    "midSentencePropertyHadExpectedValue",
                    UnquotedString(firstPropertyResult.propertyName),
                    firstPropertyResult.expectedValue,
                    left
                  )
                }
                else FailureMessages("midSentenceAllPropertiesHadExpectedValues", left)

              MatchResult(true, failureMessage, failureMessage, midSentenceFailureMessage, midSentenceFailureMessage)
          }
        }
      }
  }

  //
  // This class is used as the return type of the overloaded should method (in CollectionShouldWrapper)
  // that takes a HaveWord. It's size method will be called in situations like this:
  //
  // list should have size 1
  //
  // This gets changed to :
  //
  // convertToCollectionShouldWrapper(list).should(have).size(1)
  //
  // Thus, the list is wrapped in a convertToCollectionShouldWrapper call via an implicit conversion, which results in
  // a CollectionShouldWrapper. This has a should method that takes a HaveWord. That method returns a
  // ResultOfHaveWordForCollectionPassedToShould that remembers the map to the left of should. Then this class
  // has a size method that takes a T type, type parameter of the iterable. It does the assertion thing.
  // 
  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfHaveWordForCollection[T](left: Collection[T], shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax:
     *
     *      * collection should have size (10)
     *                        ^
     * 
     */
    def size(expectedSize: Int) {
      if ((left.size == expectedSize) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
            left,
            expectedSize)
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfHaveWordForJavaCollection[T](left: java.util.Collection[T], shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax:
     *
     *      * javaCollection should have size (10)
     *                       ^
     * 
     */
    def size(expectedSize: Int) {
      if ((left.size == expectedSize) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
            left,
            expectedSize)
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfHaveWordForJavaMap(left: java.util.Map[_, _], shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax:
     *
     *      * javaMap should have size (10)
     *                     ^
     * 
     */
    def size(expectedSize: Int) {
      if ((left.size == expectedSize) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
            left,
            expectedSize)
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfHaveWordForSeq[T](left: Seq[T], shouldBeTrue: Boolean) extends ResultOfHaveWordForCollection[T](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * seq should have length (20)
     *                 ^
     * 
     */
    def length(expectedLength: Int) {
      if ((left.length == expectedLength) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
            left,
            expectedLength)
        )
    }
  }
  
  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  class ResultOfHaveWordForArray[T](left: Array[T], shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax:
     *
     *      * array should have size (10)
     *                   ^
     * 
     */
    def size(expectedSize: Int) {
      if ((left.size == expectedSize) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
            left,
            expectedSize
          )
        )
    }

    /**
     * This method enables the following syntax:
     *
     *      * array should have length (20)
     *                   ^
     * 
     */
    def length(expectedLength: Int) {
      if ((left.length == expectedLength) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
            left,
            expectedLength
          )
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfNotWordForIterable[E, T <: Iterable[E]](left: T, shouldBeTrue: Boolean)
      extends ResultOfNotWordForAnyRef(left, shouldBeTrue) {


    /**
     * This method enables the following syntax:
     *
     *      * iterable should not contain ("one")
     *                     ^
     * 
     */
    def contain(expectedElement: E) {
      val right = expectedElement
      if ((left.exists(_ == right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainExpectedElement" else "containedExpectedElement",
              left,
              right
            )
          )
      }
    }
  }
  
  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfNotWordForCollection[E, T <: Collection[E]](left: T, shouldBeTrue: Boolean)
      extends ResultOfNotWordForIterable[E, T](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * collection should not have size (3)
     *                       ^
     * 
     */
    def have(resultOfSizeWordApplication: ResultOfSizeWordApplication) {
      val right = resultOfSizeWordApplication.expectedSize
      if ((left.size == right) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfNotWordForJavaCollection[E, T <: java.util.Collection[E]](left: T, shouldBeTrue: Boolean)
      extends ResultOfNotWordForAnyRef(left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * javaCollection should not have size (3)
     *                           ^
     * 
     */
    def have(resultOfSizeWordApplication: ResultOfSizeWordApplication) {
      val right = resultOfSizeWordApplication.expectedSize
      if ((left.size == right) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
              left,
              right
            )
          )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * javaCollection should not contain ("elephant")
     *                           ^
     * 
     */
    def contain(expectedElement: E) {
      val right = expectedElement
      if ((left.contains(right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainExpectedElement" else "containedExpectedElement",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForMap[K, V](left: scala.collection.Map[K, V], shouldBeTrue: Boolean)
      extends ResultOfNotWordForCollection[(K, V), scala.collection.Map[K, V]](left, shouldBeTrue) {


    /**
     * This method enables the following syntax:
     *
     *      * map should not contain key ("three")
     *                ^
     * 
     */
    def contain(resultOfKeyWordApplication: ResultOfKeyWordApplication[K]) {
      val right = resultOfKeyWordApplication.expectedKey
      if ((left.contains(right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainKey" else "containedKey",
              left,
              right
            )
          )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * Map("one" -> 1, "two" -> 2) should not contain value (3)
     *                                        ^
     * 
     */
    def contain(resultOfValueWordApplication: ResultOfValueWordApplication[V]) {
      val right = resultOfValueWordApplication.expectedValue
      if ((left.values.exists(_ == right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainValue" else "containedValue",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForJavaMap[K, V](left: java.util.Map[K, V], shouldBeTrue: Boolean)
      extends ResultOfNotWordForAnyRef(left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * javaMap should not contain key ("three")
     *                    ^
     * 
     */
    def contain(resultOfKeyWordApplication: ResultOfKeyWordApplication[K]) {
      val right = resultOfKeyWordApplication.expectedKey
      if ((left.containsKey(right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainKey" else "containedKey",
              left,
              right
            )
          )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * javaMap should not contain value (3)
     *                            ^
     * 
     */
    def contain(resultOfValueWordApplication: ResultOfValueWordApplication[V]) {
      val right = resultOfValueWordApplication.expectedValue
      if ((left.containsValue(right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainValue" else "containedValue",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForSeq[E, T <: Seq[E]](left: T, shouldBeTrue: Boolean)
      extends ResultOfNotWordForCollection[E, T](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * List(1, 2) should not have length (12)
     *                       ^
     * 
     */
    def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) {
      val right = resultOfLengthWordApplication.expectedLength
      if ((left.length == right) != shouldBeTrue) {
          throw newTestFailedException(
            FailureMessages(
             if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or 
DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForArray[E](left: Array[E], shouldBeTrue: Boolean)
      extends ResultOfNotWordForAnyRef(left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * Array("two", "three") should not contain ("one")
     *                                  ^
     * 
     */
    def contain(expectedElement: E) {
      val right = expectedElement
      if ((left.exists(_ == right)) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotContainExpectedElement" else "containedExpectedElement",
              left,
              right
            )
          )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * Array(1, 2) should not have size (3)
     *                        ^
     * 
     */
    def have(resultOfSizeWordApplication: ResultOfSizeWordApplication) {
      val right = resultOfSizeWordApplication.expectedSize
      if ((left.size == right) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize",
              left,
              right
            )
          )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * Array(1, 2) should not have length (12)
     *                        ^
     * 
     */
    def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) {
      val right = resultOfLengthWordApplication.expectedLength
      if ((left.length == right) != shouldBeTrue) {
          throw newTestFailedException(
            FailureMessages(
             if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfHaveWordForJavaList[T](left: java.util.List[T], shouldBeTrue: Boolean) extends ResultOfHaveWordForJavaCollection[T](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * javaList should have length (12)
     *                      ^
     * 
     *
     * 
     * This method invokes size on the java.util.List passed as left to
     * determine its length.
     * 
     */
    def length(expectedLength: Int) {
      if ((left.size == expectedLength) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
            left,
            expectedLength)
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForJavaList[E, T <: java.util.List[E]](left: T, shouldBeTrue: Boolean)
      extends ResultOfNotWordForJavaCollection[E, T](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * javaList should not have length (12)
     *                     ^
     * 
     *
     * 
     * This method invokes size on the java.util.List passed as left to
     * determine its length.
     * 
     */
    def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) {
      val right = resultOfLengthWordApplication.expectedLength
      if ((left.size == right) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
              left,
              right
            )
          )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfBeWordForAnyRef[T <: AnyRef](left: T, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax:
     *
     *      * object should be theSameInstanceAs anotherObject
     *                  ^
     * 
     */
    def theSameInstanceAs(right: AnyRef) {
      if ((left eq right) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotSameInstanceAs" else "wasSameInstanceAs",
            left,
            right
          )
        )
    }

    /**
     * This method enables the following syntax:
     *
     *      * fileMock should be a ('file)
     *                    ^
     * 
     */
    def a(symbol: Symbol) {
      val matcherResult = matchSymbolToPredicateMethod(left, symbol, true, true)
      if (matcherResult.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue) matcherResult.failureMessage else matcherResult.negatedFailureMessage
        )
      }
    }

    // TODO: Check the shouldBeTrues, are they sometimes always false or true?
    /**
     * This method enables the following syntax, where badBook is, for example, of type Book and
     * goodRead refers to a BePropertyMatcher[Book]:
     *
     *      * badBook should be a (goodRead)
     *                   ^
     * 
     */
    def a(bePropertyMatcher: BePropertyMatcher[T]) {
      val result = bePropertyMatcher(left)
      if (result.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            FailureMessages("wasNotA", left, UnquotedString(result.propertyName))
          else
            FailureMessages("wasA", left, UnquotedString(result.propertyName))
        )
      }
    }

    // TODO, in both of these, the failure message doesn't have a/an
    /**
     * This method enables the following syntax:
     *
     *      * fruit should be an ('orange)
     *                 ^
     * 
     */
    def an(symbol: Symbol) {
      val matcherResult = matchSymbolToPredicateMethod(left, symbol, true, false)
      if (matcherResult.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue) matcherResult.failureMessage else matcherResult.negatedFailureMessage
        )
      }
    }

    /**
     * This method enables the following syntax, where badBook is, for example, of type Book and
     * excellentRead refers to a BePropertyMatcher[Book]:
     *
     *      * book should be an (excellentRead)
     *                ^
     * 
     */
    def an(beTrueMatcher: BePropertyMatcher[T]) {
      val beTrueMatchResult = beTrueMatcher(left)
      if (beTrueMatchResult.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            FailureMessages("wasNotAn", left, UnquotedString(beTrueMatchResult.propertyName))
          else
            FailureMessages("wasAn", left, UnquotedString(beTrueMatchResult.propertyName))
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfNotWord[T](left: T, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax:
     *
     *      * result should not equal (7)
     *                   ^
     * 
     */
    def equal(right: Any) {
      if ((left == right) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
           if (shouldBeTrue) "didNotEqual" else "equaled",
            left,
            right
          )
        )
    }

    /**
     * This method enables the following syntax:
     *
     *      * result should not be (7)
     *                   ^
     * 
     */
    def be(right: Any) {
      if ((left == right) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
           if (shouldBeTrue) "wasNotEqualTo" else "wasEqualTo",
            left,
            right
          )
        )
    }

    /**
     * This method enables the following syntax:
     *
     *      * result should not be <= (7)
     *                   ^
     * 
     */
    def be(comparison: ResultOfLessThanOrEqualToComparison[T]) {
      if (comparison(left) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotLessThanOrEqualTo" else "wasLessThanOrEqualTo",
            left,
            comparison.right
          )
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * result should not be >= (7)
     *                   ^
     * 
     */
    def be(comparison: ResultOfGreaterThanOrEqualToComparison[T]) {
      if (comparison(left) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotGreaterThanOrEqualTo" else "wasGreaterThanOrEqualTo",
            left,
            comparison.right
          )
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * result should not be < (7)
     *                   ^
     * 
     */
    def be(comparison: ResultOfLessThanComparison[T]) {
      if (comparison(left) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotLessThan" else "wasLessThan",
            left,
            comparison.right
          )
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * result should not be > (7)
     *                   ^
     * 
     */
    def be(comparison: ResultOfGreaterThanComparison[T]) {
      if (comparison(left) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotGreaterThan" else "wasGreaterThan",
            left,
            comparison.right
          )
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * result should not be === (7)
     *                   ^
     * 
     */
    def be(comparison: ResultOfTripleEqualsApplication){
      if (comparison(left) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotEqualTo" else "wasEqualTo",
            left,
            comparison.right
          )
        )
      }
    }

    /**
     * This method enables the following syntax, where odd refers to
     * a BeMatcher[Int]:
     *
     *      * 2 should not be (odd)
     *              ^
     * 
     */
    def be(beMatcher: BeMatcher[T]) {
      val result = beMatcher(left)
      if (result.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            result.failureMessage
          else
            result.negatedFailureMessage
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  sealed class ResultOfNotWordForAnyRef[T <: AnyRef](left: T, shouldBeTrue: Boolean)
      extends ResultOfNotWord[T](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * map should not be (null)
     *                ^
     * 
     */
    def be(o: Null) {
      if ((left == null) != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            FailureMessages("wasNotNull", left) 
          else
            FailureMessages("wasNull")
        )
      }
    }
    
    /**
     * This method enables the following syntax:
     *
     *      * stack should not be ('empty)
     *                  ^
     * 
     */
    def be(symbol: Symbol) {
      val matcherResult = matchSymbolToPredicateMethod(left, symbol, false, false)
      if (matcherResult.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue) matcherResult.failureMessage else matcherResult.negatedFailureMessage
        )
      }
    }

    /**
     * This method enables the following syntax, where stack is, for example, of type Stack and
     * empty refers to a BePropertyMatcher[Stack]:
     *
     *      * stack should not be (empty)
     *                      ^
     * 
     */
    def be(bePropertyMatcher: BePropertyMatcher[T]) {
      val result = bePropertyMatcher(left)
      if (result.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            FailureMessages("wasNot", left, UnquotedString(result.propertyName))
          else
            FailureMessages("was", left, UnquotedString(result.propertyName))
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * notFileMock should not be a ('file)
     *                        ^
     * 
     */
    def be(resultOfAWordApplication: ResultOfAWordToSymbolApplication) {
      val matcherResult = matchSymbolToPredicateMethod(left, resultOfAWordApplication.symbol, true, true)
      if (matcherResult.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue) matcherResult.failureMessage else matcherResult.negatedFailureMessage
        )
      }
    }

    /**
     * This method enables the following syntax, where notFileMock is, for example, of type File and
     * file refers to a BePropertyMatcher[File]:
     *
     *      * notFileMock should not be a (file)
     *                        ^
     * 
     */
    def be[U >: T](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[U]) {
      val result = resultOfAWordApplication.bePropertyMatcher(left)
      if (result.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            FailureMessages("wasNotA", left, UnquotedString(result.propertyName))
          else
            FailureMessages("wasA", left, UnquotedString(result.propertyName))
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * keyEvent should not be an ('actionKey)
     *                     ^
     * 
     */
    def be(resultOfAnWordApplication: ResultOfAnWordToSymbolApplication) {
      val matcherResult = matchSymbolToPredicateMethod(left, resultOfAnWordApplication.symbol, true, false)
      if (matcherResult.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue) matcherResult.failureMessage else matcherResult.negatedFailureMessage
        )
      }
    }

    /**
     * This method enables the following syntax, where keyEvent is, for example, of type KeyEvent and
     * actionKey refers to a BePropertyMatcher[KeyEvent]:
     *
     *      * keyEvent should not be an (actionKey)
     *                     ^
     * 
     */
    def be[U >: T](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[U]) {
      val result = resultOfAnWordApplication.bePropertyMatcher(left)
      if (result.matches != shouldBeTrue) {
        throw newTestFailedException(
          if (shouldBeTrue)
            FailureMessages("wasNotAn", left, UnquotedString(result.propertyName))
          else
            FailureMessages("wasAn", left, UnquotedString(result.propertyName))
        )
      }
    }

    /**
     * This method enables the following syntax:
     *
     *      * otherString should not be theSameInstanceAs (string)
     *                        ^
     * 
     */
    def be(resultOfSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication) {
      if ((resultOfSameInstanceAsApplication.right eq left) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotSameInstanceAs" else "wasSameInstanceAs",
            left,
            resultOfSameInstanceAsApplication.right
          )
        )
      }
    }

    // TODO: Explain this matrix somewhere
    // The type parameter U has T as its lower bound, which means that U must be T or a supertype of T. Left is T, oh, because
    // HavePropertyMatcher is contravariant in its type parameter T, and that nmakes sense, because a HavePropertyMatcher of Any should
    // be able to match on a String.
    // not have (a (1), b (2)) must mean the opposite of have (a (1), b (2)), which means that 
    // not have (a (1), b (2)) will be true if either (a (1)).matches or (b (1)).matches is false.
    // Only if both (a (1)).matches or (b (1)).matches are true will not have (a (1), b (2)) be false.
    // title/author matches | have | have not
    // 0 0 | 0 | 1 
    // 0 1 | 0 | 1
    // 1 0 | 0 | 1
    // 1 1 | 1 | 0
    // 
    /**
     * This method enables the following syntax, where badBook is, for example, of type Book and
     * title ("One Hundred Years of Solitude") results in a HavePropertyMatcher[Book]:
     *
     *      * book should not have (title ("One Hundred Years of Solitude"))
     *                 ^
     * 
     */
    def have[U >: T](firstPropertyMatcher: HavePropertyMatcher[U, _], propertyMatchers: HavePropertyMatcher[U, _]*) {

      val results =
        for (propertyVerifier <- firstPropertyMatcher :: propertyMatchers.toList) yield
          propertyVerifier(left)

      val firstFailureOption = results.find(pv => !pv.matches)

      val justOneProperty = propertyMatchers.length == 0

      // if shouldBeTrue is false, then it is like "not have ()", and should throw TFE if firstFailureOption.isDefined is false
      // if shouldBeTrue is true, then it is like "not (not have ()), which should behave like have ()", and should throw TFE if firstFailureOption.isDefined is true
      if (firstFailureOption.isDefined == shouldBeTrue) {
        firstFailureOption match {
          case Some(firstFailure) =>
            // This is one of these cases, thus will only get here if shouldBeTrue is true
            // 0 0 | 0 | 1
            // 0 1 | 0 | 1
            // 1 0 | 0 | 1
            throw newTestFailedException(
              FailureMessages(
                "propertyDidNotHaveExpectedValue",
                 UnquotedString(firstFailure.propertyName),
                 firstFailure.expectedValue,
                 firstFailure.actualValue,
                 left
              )
            )
          case None =>
            // This is this cases, thus will only get here if shouldBeTrue is false
            // 1 1 | 1 | 0
            val failureMessage =
              if (justOneProperty) {
                val firstPropertyResult = results.head // know this will succeed, because firstPropertyMatcher was required
                FailureMessages(
                  "propertyHadExpectedValue",
                  UnquotedString(firstPropertyResult.propertyName),
                  firstPropertyResult.expectedValue,
                  left
                )
              }
              else FailureMessages("allPropertiesHadExpectedValues", left)

            throw newTestFailedException(failureMessage)
        } 
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForString(left: String, shouldBeTrue: Boolean)
      extends ResultOfNotWordForAnyRef[String](left, shouldBeTrue) {

    /**
     * This method enables the following syntax:
     *
     *      * string should not have length (12)
     *                   ^
     * 
     */
    def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) {
      val right = resultOfLengthWordApplication.expectedLength
      if ((left.length == right) != shouldBeTrue) {
          throw newTestFailedException(
            FailureMessages(
             if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
              left,
              right
            )
          )
      }
    }

    /**
     * This method enables the following syntax: 
     *
     *      * string should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")
     *                   ^
     * 
     *
     * 
     * The regular expression passed following the regex token can be either a String
     * or a scala.util.matching.Regex.
     * 
     */
    def fullyMatch(resultOfRegexWordApplication: ResultOfRegexWordApplication) {
      val rightRegex = resultOfRegexWordApplication.regex
      if (rightRegex.pattern.matcher(left).matches != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotFullyMatchRegex" else "fullyMatchedRegex",
            left,
            rightRegex
          )
        )
    }

    /**
     * This method enables the following syntax: 
     *
     *      * string should not include regex ("wo.ld")
     *                   ^
     * 
     *
     * 
     * The regular expression passed following the regex token can be either a String
     * or a scala.util.matching.Regex.
     * 
     */
    def include(resultOfRegexWordApplication: ResultOfRegexWordApplication) {
      val rightRegex = resultOfRegexWordApplication.regex
      if (rightRegex.findFirstIn(left).isDefined != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotIncludeRegex" else "includedRegex",
            left,
            rightRegex
          )
        )
    }

    /**
     * This method enables the following syntax: 
     *
     *      * string should not include ("world")
     *                   ^
     * 
     */
    def include(expectedSubstring: String) {
      if ((left.indexOf(expectedSubstring) >= 0) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotIncludeSubstring" else "includedSubstring",
            left,
            expectedSubstring
          )
        )
    }

    /**
     * This method enables the following syntax: 
     *
     *      * string should not startWith regex ("Hel*o")
     *                   ^
     * 
     *
     * 
     * The regular expression passed following the regex token can be either a String
     * or a scala.util.matching.Regex.
     * 
     */
    def startWith(resultOfRegexWordApplication: ResultOfRegexWordApplication) {
      val rightRegex = resultOfRegexWordApplication.regex
      if (rightRegex.pattern.matcher(left).lookingAt != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotStartWithRegex" else "startedWithRegex",
            left,
            rightRegex
          )
        )
    }

    /**
     * This method enables the following syntax: 
     *
     *      * "eight" should not startWith ("1.7")
     *                    ^
     * 
     */
    def startWith(expectedSubstring: String) {
      if ((left.indexOf(expectedSubstring) == 0) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotStartWith" else "startedWith",
            left,
            expectedSubstring
          )
        )
    }

    /**
     * This method enables the following syntax: 
     *
     *      * greeting should not endWith regex ("wor.d")
     *                     ^
     * 
     */
    def endWith(resultOfRegexWordApplication: ResultOfRegexWordApplication) {
      val rightRegex = resultOfRegexWordApplication.regex
      val allMatches = rightRegex.findAllIn(left)
      if (allMatches.hasNext && (allMatches.end == left.length) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotEndWithRegex" else "endedWithRegex",
            left,
            rightRegex
          )
        )
    }

    /**
     * This method enables the following syntax: 
     *
     *      * "eight" should not endWith ("1.7")
     *                    ^
     * 
     */
    def endWith(expectedSubstring: String) {
      if ((left endsWith expectedSubstring) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotEndWith" else "endedWith",
            left,
            expectedSubstring
          )
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForDouble(left: Double, shouldBeTrue: Boolean)
      extends ResultOfNotWord[Double](left, shouldBeTrue) {

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOh should not be (6.5 plusOrMinus 0.2)
     *                       ^
     * 
     */
    def be(doubleTolerance: DoubleTolerance) {
      import doubleTolerance._
      if ((left <= right + tolerance && left >= right - tolerance) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotPlusOrMinus" else "wasPlusOrMinus",
            left,
            right,
            tolerance
          )
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForFloat(left: Float, shouldBeTrue: Boolean)
      extends ResultOfNotWord[Float](left, shouldBeTrue) {

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOhFloat should not be (6.5f plusOrMinus 0.2f)
     *                            ^
     * 
     */
    def be(floatTolerance: FloatTolerance) {
      import floatTolerance._
      if ((left <= right + tolerance && left >= right - tolerance) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotPlusOrMinus" else "wasPlusOrMinus",
            left,
            right,
            tolerance
          )
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForLong(left: Long, shouldBeTrue: Boolean)
      extends ResultOfNotWord[Long](left, shouldBeTrue) {

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOhLong should not be (4L plusOrMinus 2L)
     *                           ^
     * 
     */
    def be(longTolerance: LongTolerance) {
      import longTolerance._
      if ((left <= right + tolerance && left >= right - tolerance) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotPlusOrMinus" else "wasPlusOrMinus",
            left,
            right,
            tolerance
          )
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForInt(left: Int, shouldBeTrue: Boolean)
      extends ResultOfNotWord[Int](left, shouldBeTrue) {

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOhInt should not be (4 plusOrMinus 2)
     *                          ^
     * 
     */
    def be(intTolerance: IntTolerance) {
      import intTolerance._
      if ((left <= right + tolerance && left >= right - tolerance) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotPlusOrMinus" else "wasPlusOrMinus",
            left,
            right,
            tolerance
          )
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForShort(left: Short, shouldBeTrue: Boolean)
      extends ResultOfNotWord[Short](left, shouldBeTrue) {

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOhShort should not be (4.toShort plusOrMinus 2.toShort)
     *                            ^
     * 
     */
    def be(shortTolerance: ShortTolerance) {
      import shortTolerance._
      if ((left <= right + tolerance && left >= right - tolerance) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotPlusOrMinus" else "wasPlusOrMinus",
            left,
            right,
            tolerance
          )
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfNotWordForByte(left: Byte, shouldBeTrue: Boolean)
      extends ResultOfNotWord[Byte](left, shouldBeTrue) {

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOhByte should not be (4.toByte plusOrMinus 2.toByte)
     *                            ^
     * 
     */
    def be(byteTolerance: ByteTolerance) {
      import byteTolerance._
      if ((left <= right + tolerance && left >= right - tolerance) != shouldBeTrue) {
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "wasNotPlusOrMinus" else "wasPlusOrMinus",
            left,
            right,
            tolerance
          )
        )
      }
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class RegexWord {

    /**
     * This method enables the following syntax: 
     *
     *      * "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)
     *                                     ^
     * 
     */
    def apply(regexString: String) = new ResultOfRegexWordApplication(regexString)

    /**
     * This method enables the following syntax: 
     *
     *      * "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")
     *                                     ^
     * 
     */
    def apply(regex: Regex) = new ResultOfRegexWordApplication(regex)
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers 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)
   *                               ^
   * 
   *
   * @author Bill Venners
   */
  final class ResultOfRegexWordApplication(val regex: Regex) {

    /**
     * This auxiliary constructor enables the following syntax (with a passed java.lang.String): 
     *
     *      * "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")
     *                               ^
     * 
     */
    def this(regexString: String) = this(new Regex(regexString))
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfHaveWordForString(left: String, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax: 
     *
     *      * string should have length (12)
     *                    ^
     * 
     */
    def length(expectedLength: Int) {
      if ((left.length == expectedLength) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength",
            left,
            expectedLength
          )
        )
    }
  }
  
  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfIncludeWordForString(left: String, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax: 
     *
     *      * string should include regex ("world")
     *                       ^
     * 
     */
    def regex(rightRegexString: String) { regex(rightRegexString.r) }

    /**
     * This method enables the following syntax: 
     *
     *      * string should include regex ("wo.ld".r)
     *                       ^
     * 
     */
    def regex(rightRegex: Regex) {
      if (rightRegex.findFirstIn(left).isDefined != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotIncludeRegex" else "includedRegex",
            left,
            rightRegex
          )
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfStartWithWordForString(left: String, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax: 
     *
     *      * string should startWith regex ("Hel*o")
     *                         ^
     * 
     */
    def regex(rightRegexString: String) { regex(rightRegexString.r) }

    /**
     * This method enables the following syntax: 
     *
     *      * string should startWith regex ("Hel*o".r)
     *                         ^
     * 
     */
    def regex(rightRegex: Regex) {
      if (rightRegex.pattern.matcher(left).lookingAt != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotStartWithRegex" else "startedWithRegex",
            left,
            rightRegex
          )
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfEndWithWordForString(left: String, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax: 
     *
     *      * string should endWith regex ("wor.d")
     *                       ^
     * 
     */
    def regex(rightRegexString: String) { regex(rightRegexString.r) }

    /**
     * This method enables the following syntax: 
     *
     *      * string should endWith regex ("wor.d".r)
     *                       ^
     * 
     */
    def regex(rightRegex: Regex) {
      val allMatches = rightRegex.findAllIn(left)
      if ((allMatches.hasNext && (allMatches.end == left.length)) != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotEndWithRegex" else "endedWithRegex",
            left,
            rightRegex
          )
        )
    }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class ResultOfFullyMatchWordForString(left: String, shouldBeTrue: Boolean) {

    /**
     * This method enables the following syntax: 
     *
     *      * string should fullMatch regex ("Hel*o world")
     *                         ^
     * 
     */
    def regex(rightRegexString: String) { regex(rightRegexString.r) }

    /**
     * This method enables the following syntax: 
     *
     *      * string should fullymatch regex ("Hel*o world".r)
     *                          ^
     * 
     */
    def regex(rightRegex: Regex) {
      if (rightRegex.pattern.matcher(left).matches != shouldBeTrue)
        throw newTestFailedException(
          FailureMessages(
            if (shouldBeTrue) "didNotFullyMatchRegex" else "fullyMatchedRegex",
            left,
            rightRegex
          )
        )
    }
  }
  
  /**
   * This method enables the following syntax: 
   *
   *    * result should equal (7)
   *               ^
   * 
   *
   * 
   * The left should equal (right) syntax works by calling == on the left
   * value, passing in the right value, on every type except arrays. If left is an array, deepEquals
   * will be invoked on left, passing in right. Thus, even though this expression
   * will yield false, because Array's equals method compares object identity:
   * 
   * 
   *    * Array(1, 2) == Array(1, 2) // yields false
   * 
   *
   * 
   * The following expression will not result in a TestFailedException, because deepEquals compares
   * the two arrays structurally, taking into consideration the equality of the array's contents:
   * 
   *
   *    * Array(1, 2) should equal (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException)
   * 
   *
   * 
   * If you ever do want to verify that two arrays are actually the same object (have the same identity), you can use the
   * be theSameInstanceAs syntax.
   * 
   *
   */
  def equal(right: Any): Matcher[Any] =
      new Matcher[Any] {
        def apply(left: Any) =
          MatchResult(
            areEqualComparingArraysStructurally(left, right),
            FailureMessages("didNotEqual", left, right),
            FailureMessages("equaled", left, right)
          )
      }


  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
/*
  final class TreatedAsOrderedWrapper {
    def <[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left < right,
            FailureMessages("wasNotLessThan", left, right),
            FailureMessages("wasLessThan", left, right)
          )
      }
    def >[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left > right,
            FailureMessages("wasNotGreaterThan", left, right),
            FailureMessages("wasGreaterThan", left, right)
          )
      }
    def <=[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left <= right,
            FailureMessages("wasNotLessThanOrEqualTo", left, right),
            FailureMessages("wasLessThanOrEqualTo", left, right)
          )
      }
    def >=[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left >= right,
            FailureMessages("wasNotGreaterThanOrEqualTo", left, right),
            FailureMessages("wasGreaterThanOrEqualTo", left, right)
          )
      }
  }

  // This one is for one should be < (7)
  implicit def convertBeWordToForOrdered(beWord: BeWord): TreatedAsOrderedWrapper = new TreatedAsOrderedWrapper
*/

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers 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)
   * 
   * @author Bill Venners
   */
  final class BeWord {


    /**
     * This method enables the following syntax: 
     *
     *      * result should be < (7)
     *                  ^
     * 
     *
     * 
     * Note that the less than operator will be invoked on be in this expression, not
     * on a result of passing be to should, as with most other operators
     * in the matchers DSL, because the less than operator has a higher precedence than should.
     * Thus in the above case the first expression evaluated will be be < (7), which results
     * in a matcher that is passed to should.
     * 
     *
     * 
     * This method also enables the following syntax:
     * 
     *
     *      * result should not (be < (7))
     *                       ^
     * 
     */
    def <[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left < right,
            FailureMessages("wasNotLessThan", left, right),
            FailureMessages("wasLessThan", left, right)
          )
      }

    /**
     * This method enables the following syntax: 
     *
     *      * result should be > (7)
     *                  ^
     * 
     *
     * 
     * Note that the greater than operator will be invoked on be in this expression, not
     * on a result of passing be to should, as with most other operators
     * in the matchers DSL, because the greater than operator has a higher precedence than should.
     * Thus in the above case the first expression evaluated will be be > (7), which results
     * in a matcher that is passed to should.
     * 
     *
     * 
     * This method also enables the following syntax:
     * 
     *
     *      * result should not (be > (7))
     *                       ^
     * 
     */
    def >[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left > right,
            FailureMessages("wasNotGreaterThan", left, right),
            FailureMessages("wasGreaterThan", left, right)
          )
      }

    /**
     * This method enables the following syntax: 
     *
     *      * result should be <= (7)
     *                  ^
     * 
     *
     * 
     * Note that the less than or equal to operator will be invoked on be in this expression, not
     * on a result of passing be to should, as with most other operators
     * in the matchers DSL, because the less than or equal to operator has a higher precedence than should.
     * Thus in the above case the first expression evaluated will be be <= (7), which results
     * in a matcher that is passed to should.
     * 
     *
     * 
     * This method also enables the following syntax:
     * 
     *
     *      * result should not (be <= (7))
     *                       ^
     * 
     */
    def <=[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left <= right,
            FailureMessages("wasNotLessThanOrEqualTo", left, right),
            FailureMessages("wasLessThanOrEqualTo", left, right)
          )
      }

    /**
     * This method enables the following syntax: 
     *
     *      * result should be >= (7)
     *                  ^
     * 
     *
     * 
     * Note that the greater than or equal to operator will be invoked on be in this expression, not
     * on a result of passing be to should, as with most other operators
     * in the matchers DSL, because the greater than or equal to operator has a higher precedence than should.
     * Thus in the above case the first expression evaluated will be be >= (7), which results
     * in a matcher that is passed to should.
     * 
     *
     * 
     * This method also enables the following syntax:
     * 
     *
     *      * result should not (be >= (7))
     *                       ^
     * 
     */
    def >=[T <% Ordered[T]](right: T): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) =
          MatchResult(
            left >= right,
            FailureMessages("wasNotGreaterThanOrEqualTo", left, right),
            FailureMessages("wasGreaterThanOrEqualTo", left, right)
          )
      }


    /**
     * This method enables the following syntax:
     *
     *      * result should be === (7)
     *                  ^
     * 
     *
     * 
     * Note that the === operator will be invoked on be in this expression, not
     * on a result of passing be to should, as with most other operators
     * in the matchers DSL, because the ===n operator has a higher precedence than should.
     * Thus in the above case the first expression evaluated will be be === (7), which results
     * in a matcher that is passed to should.
     * 
     *
     * 
     * This method also enables the following syntax:
     * 
     *
     *      * result should not (be === (7))
     *                       ^
     * 
     */
    def ===(right: Any): Matcher[Any] =
      new Matcher[Any] {
        def apply(left: Any) =
          MatchResult(
            areEqualComparingArraysStructurally(left, right),
            FailureMessages("wasNotEqualTo", left, right),
            FailureMessages("wasEqualTo", left, right)
          )
      }

    /**
     * This method enables the following syntax: 
     *
     *      * fileMock should not { be a ('file) }
     *                          ^
     * 
     */
    def a[S <: AnyRef](right: Symbol): Matcher[S] =
      new Matcher[S] {
        def apply(left: S) = matchSymbolToPredicateMethod[S](left, right, true, true)
      }

    /**
     * This method enables the following syntax, where fileMock is, for example, of type File and
     * file refers to a BePropertyMatcher[File]:
     *
     *      * fileMock should not { be a (file) }
     *                          ^
     * 
     */
    def a[S <: AnyRef](bePropertyMatcher: BePropertyMatcher[S]): Matcher[S] =
      new Matcher[S] {
        def apply(left: S) = {
          val result = bePropertyMatcher(left)
          MatchResult(
            result.matches,
            FailureMessages("wasNotA", left, UnquotedString(result.propertyName)), 
            FailureMessages("wasA", left, UnquotedString(result.propertyName))
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * animal should not { be an ('elephant) }
     *                        ^
     * 
     */
    def an[S <: AnyRef](right: Symbol): Matcher[S] =
      new Matcher[S] {
        def apply(left: S) = matchSymbolToPredicateMethod[S](left, right, true, false)
      }

    /**
     * This method enables the following syntax, where keyEvent is, for example, of type KeyEvent and
     * actionKey refers to a BePropertyMatcher[KeyEvent]:
     *
     *      * keyEvent should not { be an (actionKey) }
     *                          ^
     * 
     */
    def an[S <: AnyRef](bePropertyMatcher: BePropertyMatcher[S]): Matcher[S] =
      new Matcher[S] {
        def apply(left: S) = {
          val result = bePropertyMatcher(left)
          MatchResult(
            result.matches,
            FailureMessages("wasNotAn", left, UnquotedString(result.propertyName)),
            FailureMessages("wasAn", left, UnquotedString(result.propertyName))
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOh should be (7.1 plusOrMinus 0.2)
     *                      ^
     * 
     */
    def apply(doubleTolerance: DoubleTolerance): Matcher[Double] =
      new Matcher[Double] {
        def apply(left: Double) = {
          import doubleTolerance._
          MatchResult(
            left <= right + tolerance && left >= right - tolerance,
            FailureMessages("wasNotPlusOrMinus", left, right, tolerance),
            FailureMessages("wasPlusOrMinus", left, right, tolerance)
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * sevenDotOhFloat should be (7.1f plusOrMinus 0.2f)
     *                           ^
     * 
     */
    def apply(floatTolerance: FloatTolerance): Matcher[Float] =
      new Matcher[Float] {
        def apply(left: Float) = {
          import floatTolerance._
          MatchResult(
            left <= right + tolerance && left >= right - tolerance,
            FailureMessages("wasNotPlusOrMinus", left, right, tolerance),
            FailureMessages("wasPlusOrMinus", left, right, tolerance)
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * sevenLong should be (7L plusOrMinus 2L)
     *                     ^
     * 
     */
    def apply(longTolerance: LongTolerance): Matcher[Long] =
      new Matcher[Long] {
        def apply(left: Long) = {
          import longTolerance._
          MatchResult(
            left <= right + tolerance && left >= right - tolerance,
            FailureMessages("wasNotPlusOrMinus", left, right, tolerance),
            FailureMessages("wasPlusOrMinus", left, right, tolerance)
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * sevenInt should be (7 plusOrMinus 2)
     *                     ^
     * 
     */
    def apply(intTolerance: IntTolerance): Matcher[Int] =
      new Matcher[Int] {
        def apply(left: Int) = {
          import intTolerance._
          MatchResult(
            left <= right + tolerance && left >= right - tolerance,
            FailureMessages("wasNotPlusOrMinus", left, right, tolerance),
            FailureMessages("wasPlusOrMinus", left, right, tolerance)
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * sevenShort should be (7.toShort plusOrMinus 2.toShort)
     *                     ^
     * 
     */
    def apply(shortTolerance: ShortTolerance): Matcher[Short] =
      new Matcher[Short] {
        def apply(left: Short) = {
          import shortTolerance._
          MatchResult(
            left <= right + tolerance && left >= right - tolerance,
            FailureMessages("wasNotPlusOrMinus", left, right, tolerance),
            FailureMessages("wasPlusOrMinus", left, right, tolerance)
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * sevenByte should be (7.toByte plusOrMinus 2.toByte)
     *                     ^
     * 
     */
    def apply(byteTolerance: ByteTolerance): Matcher[Byte] =
      new Matcher[Byte] {
        def apply(left: Byte) = {
          import byteTolerance._
          MatchResult(
            left <= right + tolerance && left >= right - tolerance,
            FailureMessages("wasNotPlusOrMinus", left, right, tolerance),
            FailureMessages("wasPlusOrMinus", left, right, tolerance)
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * object should be theSameInstancreAs (anotherObject)
     *                  ^
     * 
     */
    def theSameInstanceAs(right: AnyRef): Matcher[AnyRef] =
      new Matcher[AnyRef] {
        def apply(left: AnyRef) =
          MatchResult(
            left eq right,
            FailureMessages("wasNotSameInstanceAs", left, right),
            FailureMessages("wasSameInstanceAs", left, right)
          )
      }

    /**
     * This method enables the following syntax: 
     *
     *      * result should be (true)
     *                  ^
     * 
     */
    def apply(right: Boolean) = 
      new Matcher[Boolean] {
        def apply(left: Boolean) =
          MatchResult(
            left == right,
            FailureMessages("wasNot", left, right),
            FailureMessages("was", left, right)
          )
      }

/* Well heck if I don't need this one
      [fsc] both method apply in class BeWord of type [T](org.scalatest.BePropertyMatcher[T])org.scalatest.Matcher[T]
      [fsc] and  method apply in class BeWord of type [T](org.scalatest.BeMatcher[T])org.scalatest.Matcher[T]
      [fsc] match argument types (Null)
      [fsc]         o should be (null)
      [fsc]                  ^
*/

    /**
     * This method enables the following syntax: 
     *
     *      * object should be (null)
     *                  ^
     * 
     */
    def apply(o: Null) = 
      new Matcher[AnyRef] {
        def apply(left: AnyRef) = {
          MatchResult(
            left == null,
            FailureMessages("wasNotNull", left),
            FailureMessages("wasNull"),
            FailureMessages("wasNotNull", left),
            FailureMessages("midSentenceWasNull")
          )
        }
      }

    /**
     * This method enables the following syntax: 
     *
     *      * set should be ('empty)
     *               ^
     * 
     */
    def apply[S <: AnyRef](right: Symbol): Matcher[S] =
      new Matcher[S] {
        def apply(left: S) = matchSymbolToPredicateMethod[S](left, right, false, false)
      }

    /**
     * This method enables the following syntax, where num is, for example, of type Int and
     * odd refers to a BeMatcher[Int]:
     *
     *      * num should be (odd)
     *               ^
     * 
     */
    def apply[T](right: BeMatcher[T]): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) = right(left)
      }

    /**
     * This method enables the following syntax, where open refers to a BePropertyMatcher:
     *
     *      * door should be (open)
     *                ^
     * 
     */
    def apply[T](bePropertyMatcher: BePropertyMatcher[T]): Matcher[T] =
      new Matcher[T] {
        def apply(left: T) = {
          val result = bePropertyMatcher(left)
          MatchResult(
            result.matches,
            FailureMessages("wasNot", left, UnquotedString(result.propertyName)), 
            FailureMessages("was", left, UnquotedString(result.propertyName))
          )
        }
      }

    /**
     * This method enables be to be used for equality comparison. Here are some examples: 
     *
     *      * object should be (None)
     *                  ^
     * object should be (Some(1))
     *                  ^
     * result should be (true)
     *                  ^
     * result should be (false)
     *                  ^
     * sum should be (19)
     *               ^
     * 
     */
    def apply(right: Any): Matcher[Any] =
      new Matcher[Any] {
        def apply(left: Any) =
          left match {
            case null =>
              MatchResult(
                right == null,
                FailureMessages("wasNotNull", right),
                FailureMessages("wasNull"),
                FailureMessages("wasNotNull", right),
                FailureMessages("midSentenceWasNull")
              )
            case _ => 
              MatchResult(
                areEqualComparingArraysStructurally(left, right),
                FailureMessages("wasNotEqualTo", left, right),
                FailureMessages("wasEqualTo", left, right)
              )
        }
      }
  }

  /**
   * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of
   * the matchers DSL.
   *
   * @author Bill Venners
   */
  final class NotWord {

    /**
     * This method enables the following syntax, where tempFile, for example, refers to a java.io.File
     * and exist is a Matcher[java.io.File]: 
     *
     *      * tempFile should not (exist)
     *                     ^
     * 
     */
    def apply[S <: Any](matcher: Matcher[S]) =
      new Matcher[S] {
        def apply(left: S) =
          matcher(left) match {
            case MatchResult(bool, s1, s2, s3, s4) => MatchResult(!bool, s2, s1, s4, s3)
          }
      }

    /**
     * This method enables any BeMatcher to be negated by passing it to not. 
     * For example, if you have a BeMatcher[Int] called odd, which matches
     * Ints that are odd, you can negate it to get a BeMatcher[Int] that matches
     * even Ints, like this:
     *
     *      * val even = not (odd)
     *                ^
     * 
     *
     * 
     * In addition, this method enables you to negate a BeMatcher at its point of use, like this:
     * 
     *
     *

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

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)

* num should be (not (odd)) * * *

* Nevertheless, in such as case it would be more idiomatic to write: *

* * * num should not be (odd) * */ def apply[S <: Any](beMatcher: BeMatcher[S]) = new BeMatcher[S] { def apply(left: S) = beMatcher(left) match { case MatchResult(bool, s1, s2, s3, s4) => MatchResult(!bool, s2, s1, s4, s3) } } /** * This method enables the following syntax: * *

     * num should (not equal (7) and be < (9))
     *                 ^
     *

*/ def equal(right: Any): Matcher[Any] = apply(matchers.equal(right)) /** * This method enables the following syntax: * *

     * Array(1, 2) should (not have length (5) and not have length (3))
     *                         ^
     *

*/ def have(resultOfLengthWordApplication: ResultOfLengthWordApplication): Matcher[AnyRef] = apply(matchers.have.length(resultOfLengthWordApplication.expectedLength)) // This looks similar to the AndNotWord one, but not quite the same because no and /** * This method enables the following syntax: * *

     * Array(1, 2) should (not have size (5) and not have size (3))
     *                         ^
     *

*/ def have(resultOfSizeWordApplication: ResultOfSizeWordApplication): Matcher[AnyRef] = apply(matchers.have.size(resultOfSizeWordApplication.expectedSize)) /** * This method enables the following syntax, where, for example, book is of type Book and title and author * are both of type HavePropertyMatcher[Book, String]: * *

     * book should (not have (title ("Moby Dick")) and (not have (author ("Melville"))))
     *                  ^
     *

*/ def have[T](firstPropertyMatcher: HavePropertyMatcher[T, _], propertyMatchers: HavePropertyMatcher[T, _]*): Matcher[T] = apply(matchers.have(firstPropertyMatcher, propertyMatchers: _*)) /** * This method enables the following syntax, where, for example, num is an Int and odd * of type BeMatcher[Int]: * *

     * num should (not be (odd) and be <= (8))
     *                 ^
     *

*/ def be[T](beMatcher: BeMatcher[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = beMatcher(left) match { case MatchResult(bool, s1, s2, s3, s4) => MatchResult(!bool, s2, s1, s4, s3) } } } /** * This method enables the following syntax: * *

     * map should (not be (null))
     *                 ^
     *

*/ def be(o: Null) = new Matcher[AnyRef] { def apply(left: AnyRef) = { MatchResult( left != null, FailureMessages("wasNull"), FailureMessages("wasNotNull", left), FailureMessages("midSentenceWasNull"), FailureMessages("wasNotNull", left) ) } } // These next four are for things like not be /<=/>=: /** * This method enables the following syntax: * *

     * num should (not be < (7) and not be > (10))
     *                 ^
     *

*/ def be[T](resultOfLessThanComparison: ResultOfLessThanComparison[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = MatchResult( !resultOfLessThanComparison(left), FailureMessages("wasLessThan", left, resultOfLessThanComparison.right), FailureMessages("wasNotLessThan", left, resultOfLessThanComparison.right) ) } } /** * This method enables the following syntax: * *

     * num should (not be > (10) and not be < (7))
     *                 ^
     *

*/ def be[T](resultOfGreaterThanComparison: ResultOfGreaterThanComparison[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = MatchResult( !resultOfGreaterThanComparison(left), FailureMessages("wasGreaterThan", left, resultOfGreaterThanComparison.right), FailureMessages("wasNotGreaterThan", left, resultOfGreaterThanComparison.right) ) } } /** * This method enables the following syntax: * *

     * num should (not be <= (7) and not be > (10))
     *                 ^
     *

*/ def be[T](resultOfLessThanOrEqualToComparison: ResultOfLessThanOrEqualToComparison[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = MatchResult( !resultOfLessThanOrEqualToComparison(left), FailureMessages("wasLessThanOrEqualTo", left, resultOfLessThanOrEqualToComparison.right), FailureMessages("wasNotLessThanOrEqualTo", left, resultOfLessThanOrEqualToComparison.right) ) } } /** * This method enables the following syntax: * *

     * num should (not be >= (10) and not be < (7))
     *                 ^
     *

*/ def be[T](resultOfGreaterThanOrEqualToComparison: ResultOfGreaterThanOrEqualToComparison[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = MatchResult( !resultOfGreaterThanOrEqualToComparison(left), FailureMessages("wasGreaterThanOrEqualTo", left, resultOfGreaterThanOrEqualToComparison.right), FailureMessages("wasNotGreaterThanOrEqualTo", left, resultOfGreaterThanOrEqualToComparison.right) ) } } /** * This method enables the following syntax: * *

     * num should (not be === (7) and not be === (10))
     *                 ^
     *

*/ def be(resultOfTripleEqualsApplication: ResultOfTripleEqualsApplication): Matcher[Any] = { new Matcher[Any] { def apply(left: Any) = MatchResult( !resultOfTripleEqualsApplication(left), FailureMessages("wasEqualTo", left, resultOfTripleEqualsApplication.right), FailureMessages("wasNotEqualTo", left, resultOfTripleEqualsApplication.right) ) } } /** * This method enables the following syntax: * *

     * myFile should (not be ('hidden) and have (name ("temp.txt")))
     *                    ^
     *

*/ def be[T <: AnyRef](symbol: Symbol): Matcher[T] = { new Matcher[T] { def apply(left: T) = { val positiveMatchResult = matchSymbolToPredicateMethod(left, symbol, false, false) MatchResult( !positiveMatchResult.matches, positiveMatchResult.negatedFailureMessage, positiveMatchResult.failureMessage ) } } } /** * This method enables the following syntax, where tempFile, for example, refers to a java.io.File * and hidden is a BePropertyMatcher[java.io.File]: * *

     * tempFile should (not be (hidden) and have ('name ("temp.txt")))
     *                    ^
     *

*/ def be[T <: AnyRef](bePropertyMatcher: BePropertyMatcher[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = { val result = bePropertyMatcher(left) MatchResult( !result.matches, FailureMessages("was", left, UnquotedString(result.propertyName)), FailureMessages("wasNot", left, UnquotedString(result.propertyName)) ) } } } /** * This method enables the following syntax: * *

     * isNotFileMock should (not be a ('file) and have ('name ("temp.txt"))))
     *                           ^
     *

*/ def be[T <: AnyRef](resultOfAWordApplication: ResultOfAWordToSymbolApplication): Matcher[T] = { new Matcher[T] { def apply(left: T) = { val positiveMatchResult = matchSymbolToPredicateMethod(left, resultOfAWordApplication.symbol, true, true) MatchResult( !positiveMatchResult.matches, positiveMatchResult.negatedFailureMessage, positiveMatchResult.failureMessage ) } } } /** * This method enables the following syntax, where notSoSecretFile, for example, refers to a java.io.File * and directory is a BePropertyMatcher[java.io.File]: * *

     * notSoSecretFile should (not be a (directory) and have ('name ("passwords.txt")))
     *                             ^
     *

*/ def be[T <: AnyRef](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = { val result = resultOfAWordApplication.bePropertyMatcher(left) MatchResult( !result.matches, FailureMessages("wasA", left, UnquotedString(result.propertyName)), FailureMessages("wasNotA", left, UnquotedString(result.propertyName)) ) } } } /** * This method enables the following syntax: * *

     * isNotAppleMock should (not be an ('apple) and not be ('rotten))
     *                            ^
     *

*/ def be[T <: AnyRef](resultOfAnWordApplication: ResultOfAnWordToSymbolApplication): Matcher[T] = { new Matcher[T] { def apply(left: T) = { val positiveMatchResult = matchSymbolToPredicateMethod(left, resultOfAnWordApplication.symbol, true, false) MatchResult( !positiveMatchResult.matches, positiveMatchResult.negatedFailureMessage, positiveMatchResult.failureMessage ) } } } /** * This method enables the following syntax: * *

     * myFile should (not be an (directory) and not be an (directory))
     *                    ^
     *

*/ def be[T <: AnyRef](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[T]): Matcher[T] = { new Matcher[T] { def apply(left: T) = { val result = resultOfAnWordApplication.bePropertyMatcher(left) MatchResult( !result.matches, FailureMessages("wasAn", left, UnquotedString(result.propertyName)), FailureMessages("wasNotAn", left, UnquotedString(result.propertyName)) ) } } } /** * This method enables the following syntax: * *

     * myFish should (not be theSameInstanceAs (redFish) and not be theSameInstanceAs (blueFish))
     *                    ^
     *

*/ def be[T <: AnyRef](resultOfTheSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication): Matcher[T] = { new Matcher[T] { def apply(left: T) = { MatchResult( resultOfTheSameInstanceAsApplication.right ne left, FailureMessages("wasSameInstanceAs", left, resultOfTheSameInstanceAsApplication.right), FailureMessages("wasNotSameInstanceAs", left, resultOfTheSameInstanceAsApplication.right) ) } } } /** * This method enables the following syntax: * *

     * sevenDotOh should ((not be (17.1 plusOrMinus 0.2)) and (not be (27.1 plusOrMinus 0.2)))
     *                         ^
     *

*/ def be(doubleTolerance: DoubleTolerance): Matcher[Double] = { import doubleTolerance._ new Matcher[Double] { def apply(left: Double) = { MatchResult( !(left <= right + tolerance && left >= right - tolerance), FailureMessages("wasPlusOrMinus", left, right, tolerance), FailureMessages("wasNotPlusOrMinus", left, right, tolerance) ) } } } /** * This method enables the following syntax: * *

     * sevenDotOhFloat should ((not be (17.1f plusOrMinus 0.2f)) and (not be (27.1f plusOrMinus 0.2f)))
     *                         ^
     *

*/ def be(floatTolerance: FloatTolerance): Matcher[Float] = { import floatTolerance._ new Matcher[Float] { def apply(left: Float) = { MatchResult( !(left <= right + tolerance && left >= right - tolerance), FailureMessages("wasPlusOrMinus", left, right, tolerance), FailureMessages("wasNotPlusOrMinus", left, right, tolerance) ) } } } /** * This method enables the following syntax: * *

     * sevenLong should ((not be (19L plusOrMinus 2L)) and (not be (29L plusOrMinus 2L)))
     *                        ^
     *

*/ def be(longTolerance: LongTolerance): Matcher[Long] = { import longTolerance._ new Matcher[Long] { def apply(left: Long) = { MatchResult( !(left <= right + tolerance && left >= right - tolerance), FailureMessages("wasPlusOrMinus", left, right, tolerance), FailureMessages("wasNotPlusOrMinus", left, right, tolerance) ) } } } /** * This method enables the following syntax: * *

     * sevenInt should ((not be (19 plusOrMinus 2)) and (not be (29 plusOrMinus 2)))
     *                       ^
     *

*/ def be(intTolerance: IntTolerance): Matcher[Int] = { import intTolerance._ new Matcher[Int] { def apply(left: Int) = { MatchResult( !(left <= right + tolerance && left >= right - tolerance), FailureMessages("wasPlusOrMinus", left, right, tolerance), FailureMessages("wasNotPlusOrMinus", left, right, tolerance) ) } } } /** * This method enables the following syntax: * *

     * sevenShort should ((not be (19.toShort plusOrMinus 2.toShort)) and (not be (29.toShort plusOrMinus 2.toShort)))
     *                         ^
     *

*/ def be(shortTolerance: ShortTolerance): Matcher[Short] = { import shortTolerance._ new Matcher[Short] { def apply(left: Short) = { MatchResult( !(left <= right + tolerance && left >= right - tolerance), FailureMessages("wasPlusOrMinus", left, right, tolerance), FailureMessages("wasNotPlusOrMinus", left, right, tolerance) ) } } } /** * This method enables the following syntax: * *

     * sevenByte should ((not be (19.toByte plusOrMinus 2.toByte)) and (not be (29.toByte plusOrMinus 2.toByte)))
     *                        ^
     *

*/ def be(byteTolerance: ByteTolerance): Matcher[Byte] = { import byteTolerance._ new Matcher[Byte] { def apply(left: Byte) = { MatchResult( !(left <= right + tolerance && left >= right - tolerance), FailureMessages("wasPlusOrMinus", left, right, tolerance), FailureMessages("wasNotPlusOrMinus", left, right, tolerance) ) } } } /** * This method enables be to be used for inequality comparison. Here are some examples: * *

     * object should not be (None)
     *                      ^
     * object should not be (Some(1))
     *                      ^
     * result should not be (true)
     *                      ^
     * result should not be (false)
     *                      ^
     * sum should not be (19)
     *                   ^
     *

*/ def be(right: Any): Matcher[Any] = { new Matcher[Any] { def apply(left: Any) = { left match { case null => MatchResult( right != null, FailureMessages("wasNull"), FailureMessages("wasNotNull", right), FailureMessages("midSentenceWasNull"), FailureMessages("wasNotNull", right) ) case _ => MatchResult( !areEqualComparingArraysStructurally(left, right), FailureMessages("wasEqualTo", left, right), FailureMessages("wasNotEqualTo", left, right) ) } } } } /** * This method enables the following syntax: * *

     * string should (not fullyMatch regex ("Hel*o) and not include ("orld"))
     *                    ^
     *

*/ def fullyMatch(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String] = { val rightRegexString = resultOfRegexWordApplication.regex.toString new Matcher[String] { def apply(left: String) = MatchResult( !java.util.regex.Pattern.matches(rightRegexString, left), FailureMessages("fullyMatchedRegex", left, UnquotedString(rightRegexString)), FailureMessages("didNotFullyMatchRegex", left, UnquotedString(rightRegexString)) ) } } /** * This method enables the following syntax: * *

     * string should (not include regex ("Hel.o") and not include regex ("""(-)?(\d+)(\.\d*)?"""))
     *                    ^
     *

*/ def include(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String] = { val rightRegex = resultOfRegexWordApplication.regex new Matcher[String] { def apply(left: String) = MatchResult( !rightRegex.findFirstIn(left).isDefined, FailureMessages("includedRegex", left, rightRegex), FailureMessages("didNotIncludeRegex", left, rightRegex) ) } } /** * This method enables the following syntax: * *

     * string should (not include ("cat") and not include ("1.7"))
     *                    ^
     *

*/ def include(expectedSubstring: String): Matcher[String] = { new Matcher[String] { def apply(left: String) = MatchResult( !(left.indexOf(expectedSubstring) >= 0), FailureMessages("includedSubstring", left, expectedSubstring), FailureMessages("didNotIncludeSubstring", left, expectedSubstring) ) } } /** * This method enables the following syntax: * *

     * string should (not startWith regex ("hel*o") and not endWith regex ("wor.d))
     *                    ^
     *

*/ def startWith(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String] = { val rightRegex = resultOfRegexWordApplication.regex new Matcher[String] { def apply(left: String) = MatchResult( !rightRegex.pattern.matcher(left).lookingAt, FailureMessages("startedWithRegex", left, rightRegex), FailureMessages("didNotStartWithRegex", left, rightRegex) ) } } /** * This method enables the following syntax: * *

     * string should ((not startWith ("red")) and (not startWith ("1.7")))
     *                     ^
     *

*/ def startWith(expectedSubstring: String): Matcher[String] = { new Matcher[String] { def apply(left: String) = MatchResult( left.indexOf(expectedSubstring) != 0, FailureMessages("startedWith", left, expectedSubstring), FailureMessages("didNotStartWith", left, expectedSubstring) ) } } /** * This method enables the following syntax: * *

     * string should (not endWith regex ("wor.d") and not startWith regex ("Hel*o"))
     *                    ^
     *

*/ def endWith(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String] = { val rightRegex = resultOfRegexWordApplication.regex new Matcher[String] { def apply(left: String) = { val allMatches = rightRegex.findAllIn(left) MatchResult( !(allMatches.hasNext && (allMatches.end == left.length)), FailureMessages("endedWithRegex", left, rightRegex), FailureMessages("didNotEndWithRegex", left, rightRegex) ) } } } /** * This method enables the following syntax: * *

     * string should (not endWith ("blue") and not endWith ("1.7"))
     *                    ^
     *

*/ def endWith(expectedSubstring: String): Matcher[String] = { new Matcher[String] { def apply(left: String) = { MatchResult( !(left endsWith expectedSubstring), FailureMessages("endedWith", left, expectedSubstring), FailureMessages("didNotEndWith", left, expectedSubstring) ) } } } /** * This method enables the following syntax: * *

     * Array(1, 2) should (not contain (5) and not contain (3))
     *                         ^
     *

*/ def contain[T](expectedElement: T): Matcher[Iterable[T]] = { new Matcher[Iterable[T]] { def apply(left: Iterable[T]) = { MatchResult( !(left.exists(_ == expectedElement)), FailureMessages("containedExpectedElement", left, expectedElement), FailureMessages("didNotContainExpectedElement", left, expectedElement) ) } } } /** * This method enables the following syntax: * *

     * Map("one" -> 1, "two" -> 2) should (not contain key ("three"))
     *                                         ^
     *

*/ def contain[K](resultOfKeyWordApplication: ResultOfKeyWordApplication[K]): Matcher[scala.collection.Map[K, Any]] = { val expectedKey = resultOfKeyWordApplication.expectedKey new Matcher[scala.collection.Map[K, Any]] { def apply(left: scala.collection.Map[K, Any]) = { MatchResult( !(left.contains(expectedKey)), FailureMessages("containedKey", left, expectedKey), FailureMessages("didNotContainKey", left, expectedKey) ) } } } /** * This method enables the following syntax: * *

     * Map("one" -> 1, "two" -> 2) should (not contain value (3))
     *                                         ^
     *

*/ def contain[K, V](resultOfValueWordApplication: ResultOfValueWordApplication[V]): Matcher[scala.collection.Map[K, V] forSome { type K }] = { val expectedValue = resultOfValueWordApplication.expectedValue new Matcher[scala.collection.Map[K, V] forSome { type K }] { def apply(left: scala.collection.Map[K, V] forSome { type K }) = { MatchResult( !(left.values.exists(_ == expectedValue)), FailureMessages("containedValue", left, expectedValue), FailureMessages("didNotContainValue", left, expectedValue) ) } } } } /** * This field enables syntax like the following: * *

   * myFile should (not be an (directory) and not have ('name ("foo.bar")))
   *                ^
   *

*/ val not = new NotWord /** * This method enables syntax such as the following: * *

   * obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string))
   *             ^
   *

*/ val be = new BeWord /* In HaveWord's methods key, value, length, and size, I can give type parameters. The type HaveWord can contain a key method that takes a S or what not, and returns a matcher, which stores the key value in a val and whose apply method checks the passed map for the remembered key. This one would be used in things like: map should { have key 9 and have value "bob" } There's an overloaded should method on Shouldifier that takes a HaveWord. This method results in a different type that also has a key method that takes an S. So when you say: map should have key 9 what happens is that this alternate should method gets invoked. The result is this other class that has a key method, and its constructor takes the map and stores it in a val. So this time when key is invoked, it checks to make sure the passed key is in the remembered map, and does the assertion. length and size can probably use structural types, because I want to use length on string and array for starters, and other people may create classes that have length methods. Would be nice to be able to use them. */ /** * This method enables syntax such as the following: * *

   * list should (have length (3) and not contain ('a'))
   *              ^
   *

*/ val have = new HaveWord /** * This method enables syntax such as the following: * *

   * list should (contain ('a') and have length (7))
   *              ^
   *

*/ val contain = new ContainWord /** * This method enables syntax such as the following: * *

   * string should (include ("hope") and not startWith ("no"))
   *                ^
   *

*/ val include = new IncludeWord /** * This method enables syntax such as the following: * *

   * string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99))
   *                ^
   *

*/ val fullyMatch = new FullyMatchWord /** * This method enables syntax such as the following: * *

   * string should (startWith ("Four") and include ("year"))
   *                ^
   *

*/ val startWith = new StartWithWord /** * This method enables syntax such as the following: * *

   * string should (endWith ("ago") and include ("score"))
   *                ^
   *

*/ val endWith = new EndWithWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfLengthWordApplication(val expectedLength: Long) extends HavePropertyMatcher[AnyRef, Long] { /** * This method enables the following syntax: * *

     * "hi" should not have (length (3))
     *                      ^
     *

* *

* This reason ResultOfLengthWordApplication is a HavePropertyMatcher[AnyRef, Long] is * so that you don't have to remember whether length needs to be surrounded by parentheses when following * have. Only length and size can be used without parentheses: everything else * needs the parentheses. So this approach means that if you use the unneeded parentheses with length and * size, it will still work. This apply method uses reflection to find and access the length * property on the passed objectWithProperty. Therefore if the object does not have the appropriate structure, the expression * will compile, but at will produce a TestFailedException at runtime. *

*/ def apply(objectWithProperty: AnyRef): HavePropertyMatchResult[Long] = { accessProperty(objectWithProperty, 'length, false) match { case None => throw newTestFailedException(Resources("propertyNotFound", "length", expectedLength.toString, "getLength")) case Some(result) => new HavePropertyMatchResult[Long]( result == expectedLength, "length", expectedLength, result match { case value: Byte => value.toLong case value: Short => value.toLong case value: Int => value.toLong case value: Long => value case _ => throw newTestFailedException(Resources("lengthPropertyNotAnInteger")) } ) } } } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class LengthWord { /** * This method enables the following syntax: * *

     * "hi" should not have length (3)
     *                             ^
     *

*/ def apply(expectedLength: Long) = new ResultOfLengthWordApplication(expectedLength) } /** * This field enables the following syntax: * *

   * "hi" should not have length (3)
   *                      ^
   *

*/ val length = new LengthWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfSizeWordApplication(val expectedSize: Long) extends HavePropertyMatcher[AnyRef, Long] { /** * This method enables the following syntax: * *

     * set should not have (size (3))
     *                     ^
     *

* *

* This reason ResultOfSizeWordApplication is a HavePropertyMatcher[AnyRef, Long] is * so that you don't have to remember whether size needs to be surrounded by parentheses when following * have. Only length and size can be used without parentheses: everything else * needs the parentheses. So this approach means that if you use the unneeded parentheses with length and * size, it will still work. This apply method uses reflection to find and access the size * property on the passed objectWithProperty. Therefore if the object does not have the appropriate structure, the expression * will compile, but at will produce a TestFailedException at runtime. *

*/ def apply(objectWithProperty: AnyRef): HavePropertyMatchResult[Long] = { accessProperty(objectWithProperty, 'size, false) match { case None => throw newTestFailedException(Resources("propertyNotFound", "size", expectedSize.toString, "getSize")) case Some(result) => new HavePropertyMatchResult[Long]( result == expectedSize, "size", expectedSize, result match { case value: Byte => value.toLong case value: Short => value.toLong case value: Int => value.toLong case value: Long => value case _ => throw newTestFailedException(Resources("sizePropertyNotAnInteger")) } ) } } } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class SizeWord { /** * This method enables the following syntax: * *

     * set should not have size (3)
     *                          ^
     *

*/ def apply(expectedSize: Long) = new ResultOfSizeWordApplication(expectedSize) } /** * This field enables the following syntax: * *

   * set should not have size (3)
   *                     ^
   *

*/ val size = new SizeWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfElementWordApplication[T](val expectedElement: T) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfKeyWordApplication[T](val expectedKey: T) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class KeyWord { /** * This method enables the following syntax: * *

     * map should not contain key (10)
     *                            ^
     *

*/ def apply[T](expectedKey: T) = new ResultOfKeyWordApplication(expectedKey) } /** * This field enables the following syntax: * *

   * map should not contain key (10)
   *                        ^
   *

*/ val key = new KeyWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfValueWordApplication[T](val expectedValue: T) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ValueWord { /** * This method enables the following syntax: * *

     * map should not contain value (10)
     *                              ^
     *

*/ def apply[T](expectedValue: T) = new ResultOfValueWordApplication(expectedValue) } /** * This field enables the following syntax: * *

   * map should not contain value (10)
   *                        ^
   *

*/ val value = new ValueWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfAWordToSymbolApplication(val symbol: Symbol) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfAWordToBePropertyMatcherApplication[T](val bePropertyMatcher: BePropertyMatcher[T]) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class AWord { /** * This method enables the following syntax: * *

     * badBook should not be a ('goodRead)
     *                         ^
     *

*/ def apply(symbol: Symbol) = new ResultOfAWordToSymbolApplication(symbol) /** * This method enables the following syntax, where, for example, badBook is of type Book and goodRead * is a BePropertyMatcher[Book]: * *

     * badBook should not be a (goodRead)
     *                         ^
     *

*/ def apply[T](beTrueMatcher: BePropertyMatcher[T]) = new ResultOfAWordToBePropertyMatcherApplication(beTrueMatcher) } /** * This field enables the following syntax: * *

   * badBook should not be a ('goodRead)
   *                       ^
   *

*/ val a = new AWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfAnWordToSymbolApplication(val symbol: Symbol) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfAnWordToBePropertyMatcherApplication[T](val bePropertyMatcher: BePropertyMatcher[T]) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class AnWord { /** * This method enables the following syntax: * *

     * badBook should not be an ('excellentRead)
     *                          ^
     *

*/ def apply(symbol: Symbol) = new ResultOfAnWordToSymbolApplication(symbol) /** * This method enables the following syntax, where, for example, badBook is of type Book and excellentRead * is a BePropertyMatcher[Book]: * *

     * badBook should not be an (excellentRead)
     *                          ^
     *

*/ def apply[T](beTrueMatcher: BePropertyMatcher[T]) = new ResultOfAnWordToBePropertyMatcherApplication(beTrueMatcher) } /** * This field enables the following syntax: * *

   * badBook should not be an (excellentRead)
   *                       ^
   *

*/ val an = new AnWord /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfTheSameInstanceAsApplication(val right: AnyRef) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class TheSameInstanceAsPhrase { /** * This method enables the following syntax: * *

     * oneString should not be theSameInstanceAs (anotherString)
     *                                           ^
     *

*/ def apply(anyRef: AnyRef) = new ResultOfTheSameInstanceAsApplication(anyRef) } /** * This field enables the following syntax: * *

   * oneString should not be theSameInstanceAs (anotherString)
   *                         ^
   *

*/ val theSameInstanceAs = new TheSameInstanceAsPhrase /** * This field enables the following syntax: * *

   * "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)
   *                               ^
   *

*/ val regex = new RegexWord /** * This method enables the following syntax: * *

   * "eight" should not include substring ("seven")
   *                            ^
   *

val substring = new SubstringWord */ /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final case class DoubleTolerance(right: Double, tolerance: Double) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class DoublePlusOrMinusWrapper(right: Double) { /** * This method enables the following syntax: * *

     * sevenDotOh should be (17.0 plusOrMinus 0.2)
     *                            ^
     *

*/ def plusOrMinus(tolerance: Double): DoubleTolerance = { if (tolerance <= 0.0) throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString)) DoubleTolerance(right, tolerance) } } /** * Implicitly converts an object of type Double to a DoublePlusOrMinusWrapper, * to enable a plusOrMinus method to be invokable on that object. */ implicit def convertDoubleToPlusOrMinusWrapper(right: Double) = new DoublePlusOrMinusWrapper(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final case class FloatTolerance(right: Float, tolerance: Float) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class FloatPlusOrMinusWrapper(right: Float) { /** * This method enables the following syntax: * *

     * sevenDotOh should be (17.0f plusOrMinus 0.2f)
     *                             ^
     *

*/ def plusOrMinus(tolerance: Float): FloatTolerance = { if (tolerance <= 0.0f) throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString)) FloatTolerance(right, tolerance) } } /** * Implicitly converts an object of type Float to a FloatPlusOrMinusWrapper, * to enable a plusOrMinus method to be invokable on that object. */ implicit def convertFloatToPlusOrMinusWrapper(right: Float) = new FloatPlusOrMinusWrapper(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final case class LongTolerance(right: Long, tolerance: Long) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class LongPlusOrMinusWrapper(right: Long) { /** * This method enables the following syntax: * *

     * seven should be (17L plusOrMinus 2)
     *                      ^
     *

*/ def plusOrMinus(tolerance: Long): LongTolerance = { if (tolerance <= 0L) throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString)) LongTolerance(right, tolerance) } } /** * Implicitly converts an object of type Long to a LongPlusOrMinusWrapper, * to enable a plusOrMinus method to be invokable on that object. */ implicit def convertLongToPlusOrMinusWrapper(right: Long) = new LongPlusOrMinusWrapper(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final case class IntTolerance(right: Int, tolerance: Int) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class IntPlusOrMinusWrapper(right: Int) { /** * This method enables the following syntax: * *

     * seven should be (17 plusOrMinus 2)
     *                     ^
     *

*/ def plusOrMinus(tolerance: Int): IntTolerance = { if (tolerance <= 0) throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString)) IntTolerance(right, tolerance) } } /** * Implicitly converts an object of type Int to a IntPlusOrMinusWrapper, * to enable a plusOrMinus method to be invokable on that object. */ implicit def convertIntToPlusOrMinusWrapper(right: Int) = new IntPlusOrMinusWrapper(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final case class ShortTolerance(right: Short, tolerance: Short) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ShortPlusOrMinusWrapper(right: Short) { /** * This method enables the following syntax: * *

     * seven should be (17.toShort plusOrMinus 2.toShort)
     *                             ^
     *

*/ def plusOrMinus(tolerance: Short): ShortTolerance = { if (tolerance <= 0) throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString)) ShortTolerance(right, tolerance) } } /** * Implicitly converts an object of type Short to a ShortPlusOrMinusWrapper, * to enable a plusOrMinus method to be invokable on that object. */ implicit def convertShortToPlusOrMinusWrapper(right: Short) = new ShortPlusOrMinusWrapper(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final case class ByteTolerance(right: Byte, tolerance: Byte) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class BytePlusOrMinusWrapper(right: Byte) { /** * This method enables the following syntax: * *

     * seven should be (17.toByte plusOrMinus 2.toByte)
     *                            ^
     *

*/ def plusOrMinus(tolerance: Byte): ByteTolerance = { if (tolerance <= 0) throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString)) ByteTolerance(right, tolerance) } } /** * Implicitly converts an object of type Byte to a BytePlusOrMinusWrapper, * to enable a plusOrMinus method to be invokable on that object. */ implicit def convertByteToPlusOrMinusWrapper(right: Byte) = new BytePlusOrMinusWrapper(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfNotWordForSizeWrapper[A <: AnyRef <% SizeWrapper](left: A, shouldBeTrue: Boolean) extends ResultOfNotWordForAnyRef(left, shouldBeTrue) { /* I just added this whole thing in here for completeness when doing SizeShouldWrapper. Write some tests to prove it is needed. // TODO: This should be for "sizey should not have size (12)" Try that test. def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) { val right = resultOfLengthWordApplication.expectedLength if ((left.length == right) != shouldBeTrue) { throw newTestFailedException( FailureMessages( if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength", left, right ) ) } } */ } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfNotWordForLengthWrapper[A <: AnyRef <% LengthWrapper](left: A, shouldBeTrue: Boolean) extends ResultOfNotWordForAnyRef(left, shouldBeTrue) { /* TODO What's going on? Why can I drop this and still get a compile // TODO: This should be for "lengthy should not have length (12)" Try that test. def have(resultOfLengthWordApplication: ResultOfLengthWordApplication) { val right = resultOfLengthWordApplication.expectedLength if ((left.length == right) != shouldBeTrue) { throw newTestFailedException( FailureMessages( if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength", left, right ) ) } } */ } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfHaveWordForLengthWrapper[A <% LengthWrapper](left: A, shouldBeTrue: Boolean) { /** * This method enables the following syntax: * *

     * obj should have length (2)
     *                      ^
     *

* *

* This method is ultimately invoked for objects that have a length property structure * of type Int, * but is of a type that is not handled by implicit conversions from nominal types such as * scala.Seq, java.lang.String, and java.util.List. *

*/ def length(expectedLength: Int) { if ((left.length == expectedLength) != shouldBeTrue) throw newTestFailedException( FailureMessages( if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength", left, expectedLength) ) } /** * This method enables the following syntax: * *

     * obj should have length (2L)
     *                      ^
     *

* *

* This method is ultimately invoked for objects that have a length property structure * of type Long, * but is of a type that is not handled by implicit conversions from nominal types such as * scala.Seq, java.lang.String, and java.util.List. *

*/ def length(expectedLength: Long) { if ((left.length == expectedLength) != shouldBeTrue) throw newTestFailedException( FailureMessages( if (shouldBeTrue) "didNotHaveExpectedLength" else "hadExpectedLength", left, expectedLength) ) } } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfHaveWordForSizeWrapper[A <% SizeWrapper](left: A, shouldBeTrue: Boolean) { /** * This method enables the following syntax: * *

     * obj should have size (2)
     *                 ^
     *

* *

* This method is ultimately invoked for objects that have a size property structure * of type Int, * but is of a type that is not handled by implicit conversions from nominal types such as * scala.Collection and java.util.Collection. *

*/ def size(expectedSize: Int) { if ((left.size == expectedSize) != shouldBeTrue) throw newTestFailedException( FailureMessages( if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize", left, expectedSize) ) } /** * This method enables the following syntax: * *

     * obj should have size (2L)
     *                 ^
     *

* *

* This method is ultimately invoked for objects that have a size property structure * of type Long, * but is of a type that is not handled by implicit conversions from nominal types such as * scala.Collection and java.util.Collection. *

*/ def size(expectedSize: Long) { if ((left.size == expectedSize) != shouldBeTrue) throw newTestFailedException( FailureMessages( if (shouldBeTrue) "didNotHaveExpectedSize" else "hadExpectedSize", left, expectedSize) ) } } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfLessThanComparison[T <% Ordered[T]](val right: T) { /** * This method is invoked by be methods to which instances of this class are passed, which * enables syntax such as: * *

     * result should not be < (7)
     *                   ^  ... invoked by this be method
     *

* *

* or *

* *

     * num should (not be < (10) and not be > (17))
     *                 ^  ... invoked by this be method
     *

*/ def apply(left: T): Boolean = left < right } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfGreaterThanComparison[T <% Ordered[T]](val right: T) { /** * This method is invoked by be methods to which instances of this class are passed, which * enables syntax such as: * *

     * result should not be > (7)
     *                   ^  ... invoked by this be method
     *

* *

* or *

* *

     * num should (not be > (10) and not be < (7))
     *                 ^  ... invoked by this be method
     *

*/ def apply(left: T): Boolean = left > right } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfLessThanOrEqualToComparison[T <% Ordered[T]](val right: T) { /** * This method is invoked by be methods to which instances of this class are passed, which * enables syntax such as: * *

     * result should not be <= (7)
     *                   ^  ... invoked by this be method
     *

* *

* or *

* *

     * num should (not be <= (10) and not be > (17))
     *                 ^  ... invoked by this be method
     *

*/ def apply(left: T): Boolean = left <= right } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfGreaterThanOrEqualToComparison[T <% Ordered[T]](val right: T) { /** * This method is invoked by be methods to which instances of this class are passed, which * enables syntax such as: * *

     * result should not be >= (7)
     *                   ^  ... invoked by this be method
     *

* *

* or *

* *

     * num should (not be >= (10) and not be < (7))
     *                 ^  ... invoked by this be method
     *

*/ def apply(left: T): Boolean = left >= right } /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfTripleEqualsApplication(val right: Any) { /** * This method is invoked by be methods to which instances of this class are passed, which * enables syntax such as: * *

     * result should not be === (7)
     *                   ^  ... invoked by this be method
     *

* *

* or *

* *

     * num should (not be === (10) and not be > (17))
     *                 ^  ... invoked by this be method
     *

*/ def apply(left: Any): Boolean = left == right } /** * This method enables the following syntax: * *

   * num should (not be < (10) and not be > (17))
   *                    ^
   *

*/ def <[T <% Ordered[T]] (right: T): ResultOfLessThanComparison[T] = new ResultOfLessThanComparison(right) /** * This method enables the following syntax: * *

   * num should (not be > (10) and not be < (7))
   *                    ^
   *

*/ def >[T <% Ordered[T]] (right: T): ResultOfGreaterThanComparison[T] = new ResultOfGreaterThanComparison(right) /** * This method enables the following syntax: * *

   * num should (not be <= (10) and not be > (17))
   *                    ^
   *

*/ def <=[T <% Ordered[T]] (right: T): ResultOfLessThanOrEqualToComparison[T] = new ResultOfLessThanOrEqualToComparison(right) /** * This method enables the following syntax: * *

   * num should (not be >= (10) and not be < (7))
   *                    ^
   *

*/ def >=[T <% Ordered[T]] (right: T): ResultOfGreaterThanOrEqualToComparison[T] = new ResultOfGreaterThanOrEqualToComparison(right) /** * This method enables the following syntax: * *

   * num should not be === (10)
   *                   ^
   *

*/ def === (right: Any): ResultOfTripleEqualsApplication = new ResultOfTripleEqualsApplication(right) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfEvaluatingApplication(val fun: () => Any) /** * This method enables syntax such as the following: * *

   * evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException]
   * ^
   *

*/ def evaluating(fun: => Any): ResultOfEvaluatingApplication = new ResultOfEvaluatingApplication(fun _) /** * This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of * the matchers DSL. * * @author Bill Venners */ final class ResultOfProduceInvocation[T](val clazz: Class[T]) /** * This method enables the following syntax: * *

   * evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException]
   * ^
   *

*/ def produce[T](implicit manifest: Manifest[T]): ResultOfProduceInvocation[T] = new ResultOfProduceInvocation(manifest.erasure.asInstanceOf[Class[T]]) }