org.scalatest.matchers

BePropertyMatchResult

class BePropertyMatchResult(matches: Boolean, propertyName: String) extends Product

The result of a Boolean property match operation, such as one performed by a BePropertyMatcher, which contains one field that indicates whether the match succeeded (i.e., the Boolean property was true) and one field that provides the name of the property.

For an example of a BePropertyMatchResult in action, see the documentation for BePropertyMatcher.

matches

indicates whether or not the matcher matched (if the Boolean property was true, it was a match)

propertyName

the name of the Boolean property that was matched against

attributes: final
Go to: companion

Inherits

  1. Product
  2. Equals
  3. AnyRef
  4. Any

Value Members

  1. def canEqual(arg0: Any): Boolean

  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.

    Go to: companion
  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.

    Go to: companion
  4. val matches: Boolean

  5. def productArity: Int

  6. def productElement(arg0: Int): Any

  7. def productElements: Iterator[Any]

  8. def productIterator: Iterator[Any]

  9. def productPrefix: String

  10. val propertyName: String

  11. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    Go to: companion

Instance constructors

  1. new BePropertyMatchResult(matches: Boolean, propertyName: String)

  2. new BePropertyMatchResult()