org.scalatest.matchers

Matchers

trait Matchers extends Assertions

This trait is part of the ScalaTest matchers DSL. Please see the documentation for ShouldMatchers orMustMatchers for an overview of the matchers DSL.

known subclasses: ShouldMatchers, MustMatchers
    authors:
  1. Bill Venners

Inherited
  1. Hide All
  2. Show all
  1. Assertions
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Type Members

  1. class AWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  2. class AnWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  3. class BeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  4. class BytePlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  5. class ByteTolerance(right: Byte, tolerance: Byte) extends Product

    This class is part of the ScalaTest matchers DSL.

  6. class ContainWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  7. class DoublePlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  8. class DoubleTolerance(right: Double, tolerance: Double) extends Product

    This class is part of the ScalaTest matchers DSL.

  9. class EndWithWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  10. class Equalizer extends AnyRef

    Class used via an implicit conversion to enable any two objects to be compared with=== in assertions in tests.

  11. class FloatPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  12. class FloatTolerance(right: Float, tolerance: Float) extends Product

    This class is part of the ScalaTest matchers DSL.

  13. class FullyMatchWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  14. class HavePropertyMatcherGenerator extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  15. class HaveWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  16. class IncludeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  17. class IntPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  18. class IntTolerance(right: Int, tolerance: Int) extends Product

    This class is part of the ScalaTest matchers DSL.

  19. class KeyWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  20. class LengthWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  21. class LengthWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  22. class LongPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  23. class LongTolerance(right: Long, tolerance: Long) extends Product

    This class is part of the ScalaTest matchers DSL.

  24. class MatcherWrapper[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  25. class NotWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  26. class RegexWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  27. class ResultOfAWordToBePropertyMatcherApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  28. class ResultOfAWordToSymbolApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  29. class ResultOfAnWordToBePropertyMatcherApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  30. class ResultOfAnWordToSymbolApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  31. class ResultOfBeWordForAnyRef[T <: AnyRef] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  32. class ResultOfContainWordForJavaMap[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  33. class ResultOfContainWordForMap[K, V] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  34. class ResultOfElementWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  35. class ResultOfEndWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  36. class ResultOfEvaluatingApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  37. class ResultOfFullyMatchWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  38. class ResultOfGreaterThanComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  39. class ResultOfGreaterThanOrEqualToComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  40. class ResultOfHaveWordForArray[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  41. class ResultOfHaveWordForCollection[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  42. class ResultOfHaveWordForJavaCollection[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  43. class ResultOfHaveWordForJavaList[T] extends ResultOfHaveWordForJavaCollection[T]

    This class is part of the ScalaTest matchers DSL.

  44. class ResultOfHaveWordForJavaMap extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  45. class ResultOfHaveWordForLengthWrapper[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  46. class ResultOfHaveWordForSeq[T] extends ResultOfHaveWordForCollection[T]

    This class is part of the ScalaTest matchers DSL.

  47. class ResultOfHaveWordForSizeWrapper[A] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  48. class ResultOfHaveWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  49. class ResultOfIncludeWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  50. class ResultOfKeyWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  51. class ResultOfLengthWordApplication extends HavePropertyMatcher[AnyRef, Long]

    This class is part of the ScalaTest matchers DSL.

  52. class ResultOfLessThanComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  53. class ResultOfLessThanOrEqualToComparison[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  54. class ResultOfNotWord[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  55. class ResultOfNotWordForAnyRef[T <: AnyRef] extends ResultOfNotWord[T]

    This class is part of the ScalaTest matchers DSL.

  56. class ResultOfNotWordForArray[E] extends ResultOfNotWordForAnyRef[Array[E]]

    This class is part of the ScalaTest matchers DSL.

  57. class ResultOfNotWordForByte extends ResultOfNotWord[Byte]

    This class is part of the ScalaTest matchers DSL.

  58. class ResultOfNotWordForCollection[E, T <: Iterable[E]] extends ResultOfNotWordForIterable[E, T]

    This class is part of the ScalaTest matchers DSL.

  59. class ResultOfNotWordForDouble extends ResultOfNotWord[Double]

    This class is part of the ScalaTest matchers DSL.

  60. class ResultOfNotWordForFloat extends ResultOfNotWord[Float]

    This class is part of the ScalaTest matchers DSL.

  61. class ResultOfNotWordForInt extends ResultOfNotWord[Int]

    This class is part of the ScalaTest matchers DSL.

  62. class ResultOfNotWordForIterable[E, T <: Iterable[E]] extends ResultOfNotWordForAnyRef[T]

    This class is part of the ScalaTest matchers DSL.

  63. class ResultOfNotWordForJavaCollection[E, T <: Collection[E]] extends ResultOfNotWordForAnyRef[T]

    This class is part of the ScalaTest matchers DSL.

  64. class ResultOfNotWordForJavaList[E, T <: List[E]] extends ResultOfNotWordForJavaCollection[E, T]

    This class is part of the ScalaTest matchers DSL.

  65. class ResultOfNotWordForJavaMap[K, V] extends ResultOfNotWordForAnyRef[Map[K, V]]

    This class is part of the ScalaTest matchers DSL.

  66. class ResultOfNotWordForLengthWrapper[A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

    This class is part of the ScalaTest matchers DSL.

  67. class ResultOfNotWordForLong extends ResultOfNotWord[Long]

    This class is part of the ScalaTest matchers DSL.

  68. class ResultOfNotWordForMap[K, V] extends ResultOfNotWordForCollection[(K, V), Map[K, V]]

    This class is part of the ScalaTest matchers DSL.

  69. class ResultOfNotWordForSeq[E, T <: Seq[E]] extends ResultOfNotWordForCollection[E, T]

    This class is part of the ScalaTest matchers DSL.

  70. class ResultOfNotWordForShort extends ResultOfNotWord[Short]

    This class is part of the ScalaTest matchers DSL.

  71. class ResultOfNotWordForSizeWrapper[A <: AnyRef] extends ResultOfNotWordForAnyRef[A]

    This class is part of the ScalaTest matchers DSL.

  72. class ResultOfNotWordForString extends ResultOfNotWordForAnyRef[String]

    This class is part of the ScalaTest matchers DSL.

  73. class ResultOfProduceInvocation[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  74. class ResultOfRegexWordApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  75. class ResultOfSizeWordApplication extends HavePropertyMatcher[AnyRef, Long]

    This class is part of the ScalaTest matchers DSL.

  76. class ResultOfStartWithWordForString extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  77. class ResultOfTheSameInstanceAsApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  78. class ResultOfTripleEqualsApplication extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  79. class ResultOfValueWordApplication[T] extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  80. class ShortPlusOrMinusWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  81. class ShortTolerance(right: Short, tolerance: Short) extends Product

    This class is part of the ScalaTest matchers DSL.

  82. class SizeWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  83. class SizeWrapper extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  84. class StartWithWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  85. class TheSameInstanceAsPhrase extends AnyRef

    This class is part of the ScalaTest matchers DSL.

  86. class ValueWord extends AnyRef

    This class is part of the ScalaTest matchers DSL.

Value Members

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

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

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

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

    arg0

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

    returns

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

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

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

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

    attributes: final
    definition classes: AnyRef
  6. def <[T](right: T)(implicit arg0: (T) ⇒ Ordered[T]): ResultOfLessThanComparison[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  7. def <=[T](right: T)(implicit arg0: (T) ⇒ Ordered[T]): ResultOfLessThanOrEqualToComparison[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  8. def ==(arg0: AnyRef): Boolean

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

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

    arg0

    the object to compare against this object for equality.

    returns

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

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

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

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

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: Any
  10. def ===(right: Any): ResultOfTripleEqualsApplication

    This method enables the following syntax:

    This method enables the following syntax:

    num should not be === (10)
                      

  11. def >[T](right: T)(implicit arg0: (T) ⇒ Ordered[T]): ResultOfGreaterThanComparison[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  12. def >=[T](right: T)(implicit arg0: (T) ⇒ Ordered[T]): ResultOfGreaterThanOrEqualToComparison[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  13. val a: AWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook should not be a ('goodRead)
                          

  14. val an: AnWord

    This field enables the following syntax:

    This field enables the following syntax:

    badBook should not be an (excellentRead)
                          

  15. def asInstanceOf[T0]: T0

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

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

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

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  16. def assert(o: Option[String]): Unit

    Assert that an Option[String] is None.

    Assert that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestFailedException with the Stringvalue of the Some included in the TestFailedException's detail message.

    This form of assert is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:

    assert(a === b)

    For more information on how this mechanism works, see the documentation forEqualizer.

    o

    the Option[String] to assert

    definition classes: Assertions
  17. def assert(o: Option[String], clue: Any): Unit

    Assert that an Option[String] is None.

    Assert that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestFailedException with the Stringvalue of the Some, as well as theString obtained by invoking toString on the specified message, included in the TestFailedException's detail message.

    This form of assert is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:

    assert(a === b, "extra info reported if assertion fails")

    For more information on how this mechanism works, see the documentation forEqualizer.

    o

    the Option[String] to assert

    clue

    An objects whose toString method returns a message to include in a failure report.

    definition classes: Assertions
  18. def assert(condition: Boolean, clue: Any): Unit

    Assert that a boolean condition, described in Stringmessage, is true.

    Assert that a boolean condition, described in Stringmessage, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with theString obtained by invoking toString on the specified message as the exception's detail message.

    condition

    the boolean condition to assert

    clue

    An objects whose toString method returns a message to include in a failure report.

    definition classes: Assertions
  19. def assert(condition: Boolean): Unit

    Assert that a boolean condition is true.

    Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.

    condition

    the boolean condition to assert

    definition classes: Assertions
  20. val be: BeWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  21. def clone(): AnyRef

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

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

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  22. val contain: ContainWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  23. implicit def convertByteToPlusOrMinusWrapper(right: Byte): BytePlusOrMinusWrapper

    Implicitly converts an object of type Byte to a BytePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    Implicitly converts an object of type Byte to a BytePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    attributes: implicit
  24. implicit def convertDoubleToPlusOrMinusWrapper(right: Double): DoublePlusOrMinusWrapper

    Implicitly converts an object of type Double to a DoublePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    Implicitly converts an object of type Double to a DoublePlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    attributes: implicit
  25. implicit def convertFloatToPlusOrMinusWrapper(right: Float): FloatPlusOrMinusWrapper

    Implicitly converts an object of type Float to a FloatPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    Implicitly converts an object of type Float to a FloatPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    attributes: implicit
  26. implicit def convertGetLengthFieldToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a getLength field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a getLength field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  27. implicit def convertGetLengthFieldToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a getLength field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a getLength field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  28. implicit def convertGetLengthMethodToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a getLength method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a getLength method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  29. implicit def convertGetLengthMethodToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a getLength method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a getLength method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  30. implicit def convertGetSizeFieldToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a getSize field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a getSize field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  31. implicit def convertGetSizeFieldToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a getSize field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a getSize field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  32. implicit def convertGetSizeMethodToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a getSize method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a getSize method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  33. implicit def convertGetSizeMethodToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a getSize method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a getSize method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  34. implicit def convertIntToPlusOrMinusWrapper(right: Int): IntPlusOrMinusWrapper

    Implicitly converts an object of type Int to a IntPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    Implicitly converts an object of type Int to a IntPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    attributes: implicit
  35. implicit def convertIterableMatcherToArraytMatcher[T](iterableMatcher: Matcher[Iterable[T]]): Matcher[Array[T]]

    attributes: implicit
  36. implicit def convertIterableMatcherToJavaCollectionMatcher[T](iterableMatcher: Matcher[Iterable[T]]): Matcher[Collection[T]]

    This implicit conversion method enables the following syntax (javaColl is a java.

    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]].

    attributes: implicit
  37. implicit def convertLengthFieldToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a length field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a length field of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  38. implicit def convertLengthFieldToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a length field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a length field of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  39. implicit def convertLengthMethodToIntLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a length method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a length method of type Int to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  40. implicit def convertLengthMethodToLongLengthWrapper(o: AnyRef {...}): LengthWrapper

    This implicit conversion method converts an object with a length method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    This implicit conversion method converts an object with a length method of type Long to aLengthWrapper, to enable that object to be used with the have length (7) syntax.

    attributes: implicit
  41. implicit def convertLongToPlusOrMinusWrapper(right: Long): LongPlusOrMinusWrapper

    Implicitly converts an object of type Long to a LongPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    Implicitly converts an object of type Long to a LongPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    attributes: implicit
  42. implicit def convertMapMatcherToJavaMapMatcher[K, V](mapMatcher: Matcher[Map[K, V]]): Matcher[Map[K, V]]

    This implicit conversion method enables the following syntax (javaMap is a java.

    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]].

    attributes: implicit
  43. implicit def convertShortToPlusOrMinusWrapper(right: Short): ShortPlusOrMinusWrapper

    Implicitly converts an object of type Short to a ShortPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    Implicitly converts an object of type Short to a ShortPlusOrMinusWrapper, to enable a plusOrMinus method to be invokable on that object.

    attributes: implicit
  44. implicit def convertSizeFieldToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a size field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a size field of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  45. implicit def convertSizeFieldToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a size field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a size field of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  46. implicit def convertSizeMethodToIntSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a size method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a size method of type Int to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  47. implicit def convertSizeMethodToLongSizeWrapper(o: AnyRef {...}): SizeWrapper

    This implicit conversion method converts an object with a size method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    This implicit conversion method converts an object with a size method of type Long to aLengthWrapper, to enable that object to be used with the have size (7) syntax.

    attributes: implicit
  48. implicit def convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol): HavePropertyMatcherGenerator

    This implicit conversion method converts a Symbol to aHavePropertyMatcherGenerator, to enable the symbol to be used with the have ('author ("Dickens")) syntax.

    This implicit conversion method converts a Symbol to aHavePropertyMatcherGenerator, to enable the symbol to be used with the have ('author ("Dickens")) syntax.

    attributes: implicit
  49. implicit def convertToEqualizer(left: Any): Equalizer

    Implicit conversion from Any to Equalizer, used to enable assertions with === comparisons.

    Implicit conversion from Any to Equalizer, used to enable assertions with === comparisons.

    For more information on this mechanism, see the documentation for Equalizer.

    Because trait Suite mixes in Assertions, this implicit conversion will always be available by default in ScalaTest Suites. This is the only implicit conversion that is in scope by default in every ScalaTest Suite. Other implicit conversions offered by ScalaTest, such as those that support the matchers DSL or invokePrivate, must be explicitly invited into your test code, either by mixing in a trait or importing the members of its companion object. The reason ScalaTest requires you to invite in implicit conversions (with the exception of the implicit conversion for === operator) is because if one of ScalaTest's implicit conversions clashes with an implicit conversion used in the code you are trying to test, your program won't compile. Thus there is a chance that if you are ever trying to use a library or test some code that also offers an implicit conversion involving a === operator, you could run into the problem of a compiler error due to an ambiguous implicit conversion. If that happens, you can turn off the implicit conversion offered by this convertToEqualizer method simply by overriding the method in yourSuite subclass, but not marking it as implicit:

    // In your Suite subclass
    override def convertToEqualizer(left: Any) = new Equalizer(left)

    left

    the object whose type to convert to Equalizer.

    attributes: implicit
    definition classes: Assertions
  50. implicit def convertToMatcherWrapper[T](leftMatcher: Matcher[T]): MatcherWrapper[T]

    This implicit conversion method enables ScalaTest matchers expressions that involve and and or.

    This implicit conversion method enables ScalaTest matchers expressions that involve and and or.

    attributes: implicit
  51. val endWith: EndWithWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  52. def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    arg0

    the object to compare against this object for reference equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  53. def equal(right: Any): Matcher[Any]

    This method enables the following syntax:

    This method enables the following syntax:

    result should equal (7)
                  

    The left should equal (right) syntax works by calling == on the leftvalue, passing in the right value, on every type except arrays. If left is an array, deepEqualswill 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 thebe theSameInstanceAs syntax.

  54. def equals(arg0: Any): Boolean

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

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

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

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

    arg0

    the object to compare against this object for equality.

    returns

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

    definition classes: AnyRef → Any
  55. def evaluating(fun: ⇒ Any): ResultOfEvaluatingApplication

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  56. def expect(expected: Any)(actual: Any): Unit

    Expect that the value passed as expected equals the value passed as actual.

    Expect that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), expect returns normally. Else, expect throws anTestFailedException whose detail message includes the expected and actual values.

    expected

    the expected value

    actual

    the actual value, which should equal the passed expected value

    definition classes: Assertions
  57. def expect(expected: Any, clue: Any)(actual: Any): Unit

    Expect that the value passed as expected equals the value passed as actual.

    Expect that the value passed as expected equals the value passed as actual. If the actual equals the expected(as determined by ==), expect returns normally. Else, if actual is not equal to expected, expect throws anTestFailedException whose detail message includes the expected and actual values, as well as the Stringobtained by invoking toString on the passed message.

    expected

    the expected value

    clue

    An object whose toString method returns a message to include in a failure report.

    actual

    the actual value, which should equal the passed expected value

    definition classes: Assertions
  58. def fail(cause: Throwable): Nothing

    Throws TestFailedException, with the passedThrowable cause, to indicate a test failed.

    Throws TestFailedException, with the passedThrowable cause, to indicate a test failed. The getMessage method of the thrown TestFailedExceptionwill return cause.toString().

    cause

    a Throwable that indicates the cause of the failure.

    definition classes: Assertions
  59. def fail(message: String, cause: Throwable): Nothing

    Throws TestFailedException, with the passedString message as the exception's detail message and Throwable cause, to indicate a test failed.

    Throws TestFailedException, with the passedString message as the exception's detail message and Throwable cause, to indicate a test failed.

    message

    A message describing the failure.

    cause

    A Throwable that indicates the cause of the failure.

    definition classes: Assertions
  60. def fail(message: String): Nothing

    Throws TestFailedException, with the passedString message as the exception's detail message, to indicate a test failed.

    Throws TestFailedException, with the passedString message as the exception's detail message, to indicate a test failed.

    message

    A message describing the failure.

    definition classes: Assertions
  61. def fail(): Nothing

    Throws TestFailedException to indicate a test failed.

    Throws TestFailedException to indicate a test failed.

    definition classes: Assertions
  62. def finalize(): Unit

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

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

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

    attributes: protected
    definition classes: AnyRef
  63. val fullyMatch: FullyMatchWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  64. def getClass(): java.lang.Class[_]

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

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

    The nature of the representation is platform dependent.

    returns

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

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

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

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

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  66. val have: HaveWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  67. val include: IncludeWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  68. def intercept[T <: AnyRef](f: ⇒ Any)(implicit manifest: Manifest[T]): T

    Intercept and return an exception that's expected to be thrown by the passed function value.

    Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

    Note that the type specified as this method's type parameter may represent any subtype ofAnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

    f

    the function value that should throw the expected exception

    manifest

    an implicit Manifest representing the type of the specified type parameter.

    returns

    the intercepted exception, if it is of the expected type

    definition classes: Assertions
  69. def isInstanceOf[T0]: Boolean

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

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

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

    returns

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

    attributes: final
    definition classes: Any
  70. val key: KeyWord

    This field enables the following syntax:

    This field enables the following syntax:

    map should not contain key (10)
                           

  71. val length: LengthWord

    This field enables the following syntax:

    This field enables the following syntax:

    "hi" should not have length (3)
                         

  72. def ne(arg0: AnyRef): Boolean

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

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

    arg0

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

    returns

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

    attributes: final
    definition classes: AnyRef
  73. val not: NotWord

    This field enables syntax like the following:

    This field enables syntax like the following:

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

  74. def notify(): Unit

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

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

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

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

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

    attributes: final
    definition classes: AnyRef
  76. def produce[T](implicit manifest: Manifest[T]): ResultOfProduceInvocation[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  77. val regex: RegexWord

    This field enables the following syntax:

    This field enables the following syntax:

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

  78. val size: SizeWord

    This field enables the following syntax:

    This field enables the following syntax:

    set should not have size (3)
                        

  79. val startWith: StartWithWord

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

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

    attributes: final
    definition classes: AnyRef
  81. val theSameInstanceAs: TheSameInstanceAsPhrase

    This field enables the following syntax:

    This field enables the following syntax:

    oneString should not be theSameInstanceAs (anotherString)
                            

  82. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  83. val value: ValueWord

    This field enables the following syntax:

    This field enables the following syntax:

    map should not contain value (10)
                           

  84. def wait(): Unit

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

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

    attributes: final
    definition classes: AnyRef
  87. def withClue(clue: Any)(fun: ⇒ Unit): Unit

    Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it.

    Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

    This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:

    withClue("(Employee's name was: " + employee.name + ")") {
      intercept[IllegalArgumentException] {
        employee.getTask(-1)
      }
    }

    If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:

    (Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown

    definition classes: Assertions