org.scalatest.matchers.ShouldMatchers

NotWord

class NotWord extends AnyRef

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

attributes: final
definition classes: Matchers

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def apply[S](beMatcher: BeMatcher[S]): BeMatcher[S]

    This method enables any BeMatcher to be negated by passing it to not

    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:

    num should be (not (odd))

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

    num should not be (odd)

  2. def apply[S](matcher: Matcher[S]): Matcher[S]

    This method enables the following syntax, where tempFile, for example, refers to a java

    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)
                        
    

  3. def be(right: Any): Matcher[Any]

    This method enables be to be used for inequality comparison

    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)
                      
    

  4. def be(byteTolerance: ByteTolerance): Matcher[Byte]

    This method enables the following syntax:

    This method enables the following syntax:

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

  5. def be(shortTolerance: ShortTolerance): Matcher[Short]

    This method enables the following syntax:

    This method enables the following syntax:

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

  6. def be(intTolerance: IntTolerance): Matcher[Int]

    This method enables the following syntax:

    This method enables the following syntax:

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

  7. def be(longTolerance: LongTolerance): Matcher[Long]

    This method enables the following syntax:

    This method enables the following syntax:

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

  8. def be(floatTolerance: FloatTolerance): Matcher[Float]

    This method enables the following syntax:

    This method enables the following syntax:

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

  9. def be(doubleTolerance: DoubleTolerance): Matcher[Double]

    This method enables the following syntax:

    This method enables the following syntax:

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

  10. def be[T <: AnyRef](resultOfTheSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  11. def be[T <: AnyRef](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[T]): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  12. def be[T <: AnyRef](resultOfAnWordApplication: ResultOfAnWordToSymbolApplication): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  13. def be[T <: AnyRef](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[T]): Matcher[T]

    This method enables the following syntax, where notSoSecretFile, for example, refers to a java

    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")))
                                
    

  14. def be[T <: AnyRef](resultOfAWordApplication: ResultOfAWordToSymbolApplication): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  15. def be[T <: AnyRef](bePropertyMatcher: BePropertyMatcher[T]): Matcher[T]

    This method enables the following syntax, where tempFile, for example, refers to a java

    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")))
                       
    

  16. def be[T <: AnyRef](symbol: Symbol): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  17. def be(resultOfTripleEqualsApplication: ResultOfTripleEqualsApplication): Matcher[Any]

    This method enables the following syntax:

    This method enables the following syntax:

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

  18. def be[T](resultOfGreaterThanOrEqualToComparison: ResultOfGreaterThanOrEqualToComparison[T]): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  19. def be[T](resultOfLessThanOrEqualToComparison: ResultOfLessThanOrEqualToComparison[T]): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  20. def be[T](resultOfGreaterThanComparison: ResultOfGreaterThanComparison[T]): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  21. def be[T](resultOfLessThanComparison: ResultOfLessThanComparison[T]): Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

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

  22. def be(o: Null): Matcher[AnyRef]

    This method enables the following syntax:

    This method enables the following syntax:

    map should (not be (null))
                    
    

  23. def be[T](beMatcher: BeMatcher[T]): Matcher[T]

    This method enables the following syntax, where, for example, num is an Int and odd of type BeMatcher[Int]:

    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))
                    
    

  24. def contain[K, V](resultOfValueWordApplication: ResultOfValueWordApplication[V]): Matcher[scala.collection.Map[_, V]]

    This method enables the following syntax:

    This method enables the following syntax:

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

  25. def contain[K](resultOfKeyWordApplication: ResultOfKeyWordApplication[K]): Matcher[Map[K, Any]]

    This method enables the following syntax:

    This method enables the following syntax:

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

  26. def contain[T](expectedElement: T): Matcher[Iterable[T]]

    This method enables the following syntax:

    This method enables the following syntax:

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

  27. def endWith(expectedSubstring: String): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

  28. def endWith(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

  29. def equal(right: Any): Matcher[Any]

    This method enables the following syntax:

    This method enables the following syntax:

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

  30. 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 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 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
  31. def fullyMatch(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

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

    definition classes: AnyRef ⇐ Any
  33. def have[T](firstPropertyMatcher: org.scalatest.matchers.HavePropertyMatcher[T, _], propertyMatchers: org.scalatest.matchers.HavePropertyMatcher[T, _]*): Matcher[T]

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

    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"))))
                     
    

  34. def have(resultOfSizeWordApplication: ResultOfSizeWordApplication): Matcher[AnyRef]

    This method enables the following syntax:

    This method enables the following syntax:

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

  35. def have(resultOfLengthWordApplication: ResultOfLengthWordApplication): Matcher[AnyRef]

    This method enables the following syntax:

    This method enables the following syntax:

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

  36. def include(expectedSubstring: String): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

  37. def include(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

  38. def startWith(expectedSubstring: String): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

  39. def startWith(resultOfRegexWordApplication: ResultOfRegexWordApplication): Matcher[String]

    This method enables the following syntax:

    This method enables the following syntax:

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

  40. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any

Instance constructors

  1. new NotWord()