org.scalatest.matchers.Matchers.BeWord

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:

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

Attributes: final

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

BeWord
AnyRef
Any

Visibility

Public
All

Instance Constructors

new BeWord ()

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def != (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
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 < (7)
                 ^
```
Note that the less than operator will be invoked on be in this expression, not on a result of passing be to should, as with most other operators in the matchers DSL, because the less than operator has a higher precedence than should. Thus in the above case the first expression evaluated will be be < (7), which results in a matcher that is passed to should.
This method also enables the following syntax:
```
result should not (be < (7))
                      ^
```
def <= [T] (right: T)(implicit 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))
                      ^
```
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def == (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
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))
                      ^
```
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 > (7)
                 ^
```
Note that the greater than operator will be invoked on be in this expression, not on a result of passing be to should, as with most other operators in the matchers DSL, because the greater than operator has a higher precedence than should. Thus in the above case the first expression evaluated will be be > (7), which results in a matcher that is passed to should.
This method also enables the following syntax:
```
result should not (be > (7))
                      ^
```
def >= [T] (right: T)(implicit 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))
                      ^
```
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) }
                         ^
```
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) }
                         ^
```
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) }
                         ^
```
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) }
                       ^
```

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:

result should be (None)
                 ^{result should be (Some(1))}
result should be (true)
                 ^{result should be (false)}
sum should be (19)
              ^

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)
               ^
```
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)
              ^
```
def apply [S <: AnyRef] (right: Symbol): Matcher[S]

This method enables the following syntax:
This method enables the following syntax:
```
set should be ('empty)
              ^
```
def apply (o: Null): Matcher[AnyRef]

This method enables the following syntax:
This method enables the following syntax:
```
result should be (null)
                 ^
```
def apply (right: Boolean): Matcher[Boolean]

This method enables the following syntax:
This method enables the following syntax:
```
result should be (true)
                 ^
```
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)
                    ^
```
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)
                    ^
```
def apply (intTolerance: IntTolerance): Matcher[Int]

This method enables the following syntax:
This method enables the following syntax:
```
sevenInt should be (7 plusOrMinus 2)
                    ^
```
def apply (longTolerance: LongTolerance): Matcher[Long]

This method enables the following syntax:
This method enables the following syntax:
```
sevenLong should be (7L plusOrMinus 2L)
                    ^
```
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)
                          ^
```
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)
                     ^
```
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
def hashCode (): Int

Definition Classes
AnyRef → Any
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def theSameInstanceAs (right: AnyRef): Matcher[AnyRef]

This method enables the following syntax:
This method enables the following syntax:
```
result should be theSameInstancreAs (anotherObject)
                 ^
```
def toString (): String

Definition Classes
AnyRef → Any
def wait (): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long, arg1: Int): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

BeWord

class BeWord extends AnyRef

Instance Constructors

new BeWord ()

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

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

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

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def asInstanceOf [T0] : T0

def clone (): AnyRef

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

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

def hashCode (): Int

def isInstanceOf [T0] : Boolean

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

def synchronized [T0] (arg0: ⇒ T0): T0

def theSameInstanceAs (right: AnyRef): Matcher[AnyRef]

def toString (): String

def wait (): Unit

def wait (arg0: Long, arg1: Int): Unit

def wait (arg0: Long): Unit

Inherited from AnyRef

Inherited from Any