org.scalatest.matchers.DeprecatedShouldMatchers

StringShouldWrapper

class StringShouldWrapper extends StringShouldWrapperForVerb

This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of the matchers DSL.

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

This class is part of the ScalaTest matchers DSL. Please see the documentation for DeprecatedShouldMatchers or DeprecatedMustMatchers for an overview of the matchers DSL.

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

attributes: final
linear super types: StringShouldWrapperForVerb, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. StringShouldWrapper
  2. StringShouldWrapperForVerb
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new StringShouldWrapper ( left : String )

Value Members

  1. def != ( arg0 : AnyRef ) : Boolean

    attributes: final
    definition classes: AnyRef

  2. def != ( arg0 : Any ) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any

  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any

  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef

  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef

  6. def == ( arg0 : AnyRef ) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef

  7. def == ( arg0 : Any ) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any

  8. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any

  9. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected[lang]
    definition classes: AnyRef
    annotations: @throws()

  10. def eq ( arg0 : AnyRef ) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef

  11. 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 [http://en.wikipedia.org/wiki/Equivalence_relation 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 scala.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

  12. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    attributes: protected[lang]
    definition classes: AnyRef
    annotations: @throws()

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

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

  14. 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.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any

  15. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any

  16. def ne ( arg0 : AnyRef ) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef

  17. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

  18. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

  19. def should ( notWord : NotWord ) : ResultOfNotWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should not have length (3)

  20. def should ( fullyMatchWord : FullyMatchWord ) : ResultOfFullyMatchWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")

  21. def should ( endWithWord : EndWithWord ) : ResultOfEndWithWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should endWith regex ("world")

  22. def should ( startWithWord : StartWithWord ) : ResultOfStartWithWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should startWith regex ("hello")

  23. def should ( includeWord : IncludeWord ) : ResultOfIncludeWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should include regex ("hi")

  24. def should ( haveWord : HaveWord ) : ResultOfHaveWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should have length (3)

  25. def should ( beWord : BeWord ) : ResultOfBeWordForAnyRef[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should be theSameInstanceAs anotherObject

  26. def should ( rightMatcher : Matcher[String] ) : Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should equal ("hi")

  27. def should ( resultOfAfterWordApplication : ResultOfAfterWordApplication )(implicit 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.

    definition classes: StringShouldWrapperForVerb

  28. def should ( right : ⇒ Unit )(implicit 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.

    definition classes: StringShouldWrapperForVerb

  29. def should ( right : BehaveWord )(implicit 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.

    definition classes: StringShouldWrapperForVerb

  30. def should ( right : String )(implicit 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.

    definition classes: StringShouldWrapperForVerb

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

    attributes: final
    definition classes: AnyRef

  32. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any

  33. def wait () : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()

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

    attributes: final
    definition classes: AnyRef
    annotations: @throws()

  35. def wait ( arg0 : Long ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()