org.scalatest.matchers.Matchers

BeWord

class BeWord 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.

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:

FieldMethod"is" MethodResult
   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()
emptyempty() Invokes empty()
emptyempty()isEmpty()Invokes empty() (this can occur when BeanProperty annotation is used)

attributes: final

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def <[T](right: T)(arg0: (T) ⇒ Ordered[T]): Matcher[T]

    This method enables the following syntax:

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

  2. def <=[T](right: T)(arg0: (T) ⇒ Ordered[T]): Matcher[T]

    This method enables the following syntax:

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

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

    This method enables the following syntax:

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

  4. def >[T](right: T)(arg0: (T) ⇒ Ordered[T]): Matcher[T]

    This method enables the following syntax:

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

  5. def >=[T](right: T)(arg0: (T) ⇒ Ordered[T]): Matcher[T]

    This method enables the following syntax:

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

  6. def a[S <: AnyRef](bePropertyMatcher: BePropertyMatcher[S]): Matcher[S]

    This method enables the following syntax, where fileMock is, for example, of type File and file refers to a BePropertyMatcher[File]:

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

  7. def a[S <: AnyRef](right: Symbol): Matcher[S]

    This method enables the following syntax:

    This method enables the following syntax:

    fileMock should not { be a ('file) }
                             
    

  8. def an[S <: AnyRef](bePropertyMatcher: BePropertyMatcher[S]): Matcher[S]

    This method enables the following syntax, where keyEvent is, for example, of type KeyEvent and actionKey refers to a BePropertyMatcher[KeyEvent]:

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

  9. def an[S <: AnyRef](right: Symbol): Matcher[S]

    This method enables the following syntax:

    This method enables the following syntax:

    animal should not { be an ('elephant) }
                           
    

  10. def apply(right: Any): Matcher[Any]

    This method enables be to be used for equality comparison

    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)
                  
    

  11. def apply[T](bePropertyMatcher: BePropertyMatcher[T]): Matcher[T]

    This method enables the following syntax, where open refers to a BePropertyMatcher:

    This method enables the following syntax, where open refers to a BePropertyMatcher:

    door should be (open)
                   
    

  12. def apply[T](right: BeMatcher[T]): Matcher[T]

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

    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)
                  
    

  13. def apply[S <: AnyRef](right: Symbol): Matcher[S]

    This method enables the following syntax:

    This method enables the following syntax:

    set should be ('empty)
                  
    

  14. def apply(o: Null): Matcher[AnyRef]

    This method enables the following syntax:

    This method enables the following syntax:

    object should be (null)
                     
    

  15. def apply(right: Boolean): Matcher[Boolean]

    This method enables the following syntax:

    This method enables the following syntax:

    result should be (true)
                     
    

  16. def apply(byteTolerance: ByteTolerance): Matcher[Byte]

    This method enables the following syntax:

    This method enables the following syntax:

    sevenByte should be (7.toByte plusOrMinus 2.toByte)
                        
    

  17. def apply(shortTolerance: ShortTolerance): Matcher[Short]

    This method enables the following syntax:

    This method enables the following syntax:

    sevenShort should be (7.toShort plusOrMinus 2.toShort)
                        
    

  18. def apply(intTolerance: IntTolerance): Matcher[Int]

    This method enables the following syntax:

    This method enables the following syntax:

    sevenInt should be (7 plusOrMinus 2)
                        
    

  19. def apply(longTolerance: LongTolerance): Matcher[Long]

    This method enables the following syntax:

    This method enables the following syntax:

    sevenLong should be (7L plusOrMinus 2L)
                        
    

  20. def apply(floatTolerance: FloatTolerance): Matcher[Float]

    This method enables the following syntax:

    This method enables the following syntax:

    sevenDotOhFloat should be (7.1f plusOrMinus 0.2f)
                              
    

  21. def apply(doubleTolerance: DoubleTolerance): Matcher[Double]

    This method enables the following syntax:

    This method enables the following syntax:

    sevenDotOh should be (7.1 plusOrMinus 0.2)
                         
    

  22. 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
  23. 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
  24. def theSameInstanceAs(right: AnyRef): Matcher[AnyRef]

    This method enables the following syntax:

    This method enables the following syntax:

    object should be theSameInstancreAs (anotherObject)
                     
    

  25. 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 BeWord()