org.scalatest.WordSpec

StringShouldWrapperForVerb

class StringShouldWrapperForVerb extends AnyRef

This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec.

This class is used in conjunction with an implicit conversion to enable should methods to be invoked on Strings.

definition classes: ShouldVerb

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 should(resultOfAfterWordApplication: ResultOfAfterWordApplication)(fun: (String, String, ResultOfAfterWordApplication) ⇒ Unit): Unit

    Supports the registration of subject descriptions with after words in WordSpec and FixtureWordSpec

    Supports the registration of subject descriptions with after words in WordSpec and FixtureWordSpec.

    For example, this method enables syntax such as the following in WordSpec and FixtureWordSpec:

       def provide = afterWord("provide")

    "The ScalaTest Matchers DSL" should provide {

    WordSpec passes in a function via the implicit parameter that takes two strings and a ResultOfAfterWordApplication and results in Unit. This method simply invokes this function, passing in left, the verb string "should", and the ResultOfAfterWordApplication passed to should.

  4. def should(right: ⇒ Unit)(fun: StringVerbBlockRegistration): Unit

    Supports the registration of subject descriptions in WordSpec and FixtureWordSpec

    Supports the registration of subject descriptions in WordSpec and FixtureWordSpec.

    For example, this method enables syntax such as the following in WordSpec and FixtureWordSpec:

    "A Stack (when empty)" should { ...
                           
    

    WordSpec passes in a function via the implicit parameter of type StringVerbBlockRegistration, a function that takes two strings and a no-arg function and results in Unit. This method simply invokes this function, passing in left, the verb string "should", and the right by-name parameter transformed into a no-arg function.

  5. def should(right: BehaveWord)(fun: (String) ⇒ BehaveWord): BehaveWord

    Supports shared test registration in FlatSpec and FixtureFlatSpec

    Supports shared test registration in FlatSpec and FixtureFlatSpec.

    For example, this method enables syntax such as the following in FlatSpec and FixtureFlatSpec:

    "A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
                              
    

    FlatSpec and FixtureFlatSpec passes in a function via the implicit parameter that takes a string and results in a BehaveWord. This method simply invokes this function, passing in left, and returns the result.

  6. def should(right: String)(fun: (String, String, String) ⇒ ResultOfStringPassedToVerb): ResultOfStringPassedToVerb

    Supports test registration in FlatSpec and FixtureFlatSpec

    Supports test registration in FlatSpec and FixtureFlatSpec.

    For example, this method enables syntax such as the following in FlatSpec and FixtureFlatSpec:

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

    FlatSpec passes in a function via the implicit parameter that takes three strings and results in a ResultOfStringPassedToVerb. This method simply invokes this function, passing in left, the verb string "should", and right, and returns the result.

  7. 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 StringShouldWrapperForVerb(left: String)

  2. new StringShouldWrapperForVerb()