org.scalatest.verb

ResultOfTaggedAsInvocation

class ResultOfTaggedAsInvocation extends AnyRef

Supports the registration of tagged tests in shorthand form in FlatSpec and FixtureFlatSpec.

For example, this class enables syntax such as the following tagged, pending test registration in shorthand form:

"A Stack (when empty)" should "be empty" taggedAs() is (pending)
                                                    

In addition, this class indirectly enables syntax such as the following tagged test registration in shorthand form:

"A Stack (when empty)" should "be empty" taggedAs() in { ... }
                                                    

Rather than provide in and ignore methods directly, these methods are provided after taggedAs() by implicit conversions because the type passed to in (and ignore) differs in a FlatSpec and a FixtureFlatSpec. A FixtureFlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture as its parameter). By constrast, a FlatSpec needs only one in method that takes a by-name parameter. As a result, FlatSpec and FixtureFlatSpec each provide an implicit conversion from ResultOfTaggedAsInvocation to a type that provides the appropriate in methods.

attributes: abstract

Inherits

  1. AnyRef
  2. Any

Value Members

  1. 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
  2. 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
  3. def is(testFun: ⇒ PendingNothing): Unit

    Supports the registration of tagged, pending tests in shorthand form in FlatSpec and FixtureFlatSpec

    Supports the registration of tagged, pending tests in shorthand form in FlatSpec and FixtureFlatSpec.

    This method supports syntax such as the following:

    "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
                                                                              
    

    For examples of tagged test registration, see the Tagging tests section in the main documentation for trait FlatSpec. For examples of pending test registration, see the Pending tests section in the main documentation for trait FlatSpec.

    attributes: abstract
  4. val rest: String

  5. val tags: List[Tag]

  6. 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
  7. val verb: String

Instance constructors

  1. new ResultOfTaggedAsInvocation(verb: String, rest: String, tags: List[Tag])

  2. new ResultOfTaggedAsInvocation()