org.scalatest.matchers.ShouldMatchers

HavePropertyMatcherGenerator

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

This class is used as the result of an implicit conversion from class Symbol, to enable symbols to be used in have ('author ("Dickens")) syntax. The name of the implicit conversion method is convertSymbolToHavePropertyMatcherGenerator.

Class HavePropertyMatcherGenerator's primary constructor takes a Symbol. The apply method uses reflection to find and access a property that has the name specified by the Symbol passed to the constructor, so it can determine if the property has the expected value passed to apply. If the symbol passed is 'title, for example, the apply method will use reflection to look for a public Java field named "title", a public method named "title", or a public method named "getTitle". If a method, it must take no parameters. If multiple candidates are found, the apply method will select based on the following algorithm:

FieldMethod"get" MethodResult
   Throws TestFailedException, because no candidates found
  getTitle()Invokes getTitle()
 title() Invokes title()
 title()getTitle()Invokes title() (this can occur when BeanProperty annotation is used)
title  Accesses field title
title getTitle()Invokes getTitle()
titletitle() Invokes title()
titletitle()getTitle()Invokes title() (this can occur when BeanProperty annotation is used)

attributes: final
definition classes: Matchers

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def apply(expectedValue: Any): HavePropertyMatcher[AnyRef, Any]

    This method enables the following syntax:

    This method enables the following syntax:

    book should have ('title ("A Tale of Two Cities"))
                             
    

    This class has an apply method that will produce a HavePropertyMatcher[AnyRef, Any]. The implicit conversion method, convertSymbolToHavePropertyMatcherGenerator, will cause the above line of code to be eventually transformed into:

    book should have (convertSymbolToHavePropertyMatcherGenerator('title).apply("A Tale of Two Cities"))
    

  2. 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
  3. 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
  4. 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 HavePropertyMatcherGenerator(symbol: Symbol)

  2. new HavePropertyMatcherGenerator()