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
linear super types: AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BeWord
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new BeWord ()

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]) : Matcher[T]

    This method enables the following syntax:

    This method enables the following syntax:

    result should be &lt; (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 &lt; (7))
                          

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

    This method enables the following syntax:

    This method enables the following syntax:

    result should be &lt;= (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 &lt;= (7))
                          

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

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

    This method enables the following syntax:

    This method enables the following syntax:

    result should be &gt; (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 &gt; (7))
                          

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

    This method enables the following syntax:

    This method enables the following syntax:

    result should be &gt;= (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 &gt;= (7))
                          

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

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

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

    fileMock should not { be a (file) }
                             

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

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

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

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

    keyEvent should not { be an (actionKey) }
                             

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

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

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

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

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

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

    num should be (odd)
                  

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

    This method enables the following syntax:

    This method enables the following syntax:

    set should be ('empty)
                  

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

    This method enables the following syntax:

    This method enables the following syntax:

    object should be (null)
                     

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

    This method enables the following syntax:

    This method enables the following syntax:

    result should be (true)
                     

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

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

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

    This method enables the following syntax:

    This method enables the following syntax:

    sevenInt should be (7 plusOrMinus 2)
                        

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

    This method enables the following syntax:

    This method enables the following syntax:

    sevenLong should be (7L plusOrMinus 2L)
                        

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

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

  29. 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
  30. 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
  31. 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
  32. 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
  33. 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
  34. 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
  35. 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
  36. 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
  37. 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
  38. 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
  39. 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
  40. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  41. def theSameInstanceAs (right: AnyRef) : Matcher[AnyRef]

    This method enables the following syntax:

    This method enables the following syntax:

    object should be theSameInstancreAs (anotherObject)
                     

  42. 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
  43. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from AnyRef

Inherited from Any