org.scalatest.Matchers

StringShouldWrapper

final class StringShouldWrapper extends AnyShouldWrapper[String] with StringShouldWrapperForVerb

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers 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.

Linear Supertypes
Matchers.StringShouldWrapperForVerb, AnyShouldWrapper[String], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StringShouldWrapper
  2. StringShouldWrapperForVerb
  3. AnyShouldWrapper
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StringShouldWrapper(leftSideValue: String)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. val leftSideValue: String

  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. 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)
           ^
    

    Definition Classes
    StringShouldWrapperAnyShouldWrapper
  19. 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*)?""")
           ^
    

  20. 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")
           ^
    

  21. 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")
           ^
    

  22. 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")
           ^
    

  23. def should(resultOfAfterWordApplication: ResultOfAfterWordApplication)(implicit fun: (String, String, ResultOfAfterWordApplication) ⇒ Unit): Unit

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

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

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

    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 leftSideValue, the verb string "should", and the ResultOfAfterWordApplication passed to should.

    Definition Classes
    StringShouldWrapperForVerb
  24. def should(right: ⇒ Unit)(implicit fun: StringVerbBlockRegistration): Unit

    Supports the registration of subject descriptions in WordSpec and fixture.WordSpec.

    Supports the registration of subject descriptions in WordSpec and fixture.WordSpec.

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

    "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 leftSideValue, the verb string "should", and the right by-name parameter transformed into a no-arg function.

    Definition Classes
    StringShouldWrapperForVerb
  25. def should(right: BehaveWord)(implicit fun: (String) ⇒ BehaveWord): BehaveWord

    Supports shared test registration in FlatSpec and fixture.FlatSpec.

    Supports shared test registration in FlatSpec and fixture.FlatSpec.

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

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

    FlatSpec and fixture.FlatSpec 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 leftSideValue, and returns the result.

    Definition Classes
    StringShouldWrapperForVerb
  26. def should(right: String)(implicit fun: (String, String, String) ⇒ ResultOfStringPassedToVerb): ResultOfStringPassedToVerb

    Supports test registration in FlatSpec and fixture.FlatSpec.

    Supports test registration in FlatSpec and fixture.FlatSpec.

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

    "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 leftSideValue, the verb string "should", and right, and returns the result.

    Definition Classes
    StringShouldWrapperForVerb
  27. def should(notExist: ResultOfNotExist)(implicit existence: Existence[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    file should not (exist)
         ^
    

    Definition Classes
    AnyShouldWrapper
  28. def should(existWord: ExistWord)(implicit existence: Existence[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    file should exist
         ^
    

    Definition Classes
    AnyShouldWrapper
  29. def should(containWord: ContainWord): ResultOfContainWord[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    xs should contain oneOf (1, 2, 3)
       ^
    

    Definition Classes
    AnyShouldWrapper
  30. def should(haveWord: HaveWord): ResultOfHaveWordForExtent[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should have length (3)
           
    result should have size (3)
           
    

    Definition Classes
    AnyShouldWrapper
  31. def should(beWord: BeWord): ResultOfBeWordForAny[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should be a aMatcher
           ^
    

    Definition Classes
    AnyShouldWrapper
  32. def should(inv: TripleEqualsInvocationOnSpread[String])(implicit ev: Numeric[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should === (100 +- 1)
           ^
    

    Definition Classes
    AnyShouldWrapper
  33. def should[U](inv: TripleEqualsInvocation[U])(implicit constraint: Constraint[String, U]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    a should === (b)
           ^
    

    Definition Classes
    AnyShouldWrapper
  34. def should[TYPECLASS1[_], TYPECLASS2[_]](rightMatcherFactory2: MatcherFactory2[String, TYPECLASS1, TYPECLASS2])(implicit typeClass1: TYPECLASS1[String], typeClass2: TYPECLASS2[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should (equal (expected) and have length 3)
           ^
    

    Definition Classes
    AnyShouldWrapper
  35. def should[TYPECLASS1[_]](rightMatcherFactory1: MatcherFactory1[String, TYPECLASS1])(implicit typeClass1: TYPECLASS1[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should equal (3)
           ^
    

    Definition Classes
    AnyShouldWrapper
  36. def should(rightMatcherX1: Matcher[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result should be (3)
           ^
    

    Definition Classes
    AnyShouldWrapper
  37. def shouldBe[U >: String](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[U])(implicit ev: <:<[String, AnyRef]): Unit

    This method enables the following syntax, where excellentRead refers to a BePropertyMatcher[Book]:

    This method enables the following syntax, where excellentRead refers to a BePropertyMatcher[Book]:

    programmingInScala shouldBe an (excellentRead)
                       ^
    

    Definition Classes
    AnyShouldWrapper
  38. def shouldBe[U >: String](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[U])(implicit ev: <:<[String, AnyRef]): Unit

    This method enables the following syntax, where goodRead refers to a BePropertyMatcher[Book]:

    This method enables the following syntax, where goodRead refers to a BePropertyMatcher[Book]:

    programmingInScala shouldBe a (goodRead)
                       ^
    

    Definition Classes
    AnyShouldWrapper
  39. def shouldBe(bePropertyMatcher: BePropertyMatcher[String])(implicit ev: <:<[String, AnyRef]): Unit

    This method enables the following syntax, where excellentRead refers to a BePropertyMatcher[Book]:

    This method enables the following syntax, where excellentRead refers to a BePropertyMatcher[Book]:

    programmingInScala shouldBe excellentRead
                       ^
    

    Definition Classes
    AnyShouldWrapper
  40. def shouldBe(resultOfAnWordApplication: ResultOfAnWordToSymbolApplication)(implicit toAnyRef: <:<[String, AnyRef]): Unit

    This method enables the following syntax:

    This method enables the following syntax:

    list shouldBe an ('empty)
         ^
    

    Definition Classes
    AnyShouldWrapper
  41. def shouldBe(resultOfAWordApplication: ResultOfAWordToSymbolApplication)(implicit toAnyRef: <:<[String, AnyRef]): Unit

    This method enables the following syntax:

    This method enables the following syntax:

    list shouldBe a ('empty)
         ^
    

    Definition Classes
    AnyShouldWrapper
  42. def shouldBe(symbol: Symbol)(implicit toAnyRef: <:<[String, AnyRef]): Unit

    This method enables the following syntax:

    This method enables the following syntax:

    list shouldBe 'empty
         ^
    

    Definition Classes
    AnyShouldWrapper
  43. def shouldBe(resultOfSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication)(implicit toAnyRef: <:<[String, AnyRef]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe theSameInstanceAs (anotherObject)
           ^
    

    Definition Classes
    AnyShouldWrapper
  44. def shouldBe(right: Null)(implicit ev: <:<[String, AnyRef]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe null
           ^
    

    Definition Classes
    AnyShouldWrapper
  45. def shouldBe(right: DefinedWord)(implicit definition: Definition[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe defined
           ^
    

    Definition Classes
    AnyShouldWrapper
  46. def shouldBe(right: EmptyWord)(implicit emptiness: Emptiness[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe empty
           ^
    

    Definition Classes
    AnyShouldWrapper
  47. def shouldBe(right: WritableWord)(implicit writability: Writability[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe writable
           ^
    

    Definition Classes
    AnyShouldWrapper
  48. def shouldBe(right: ReadableWord)(implicit readability: Readability[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe readable
           ^
    

    Definition Classes
    AnyShouldWrapper
  49. def shouldBe(anType: ResultOfAnTypeInvocation[_]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    aDouble shouldBe an [Book]
            ^
    

    Definition Classes
    AnyShouldWrapper
  50. def shouldBe(aType: ResultOfATypeInvocation[_]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    aDouble shouldBe a [Book]
            ^
    

    Definition Classes
    AnyShouldWrapper
  51. def shouldBe(right: SortedWord)(implicit sortable: Sortable[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe sorted
           ^
    

    Definition Classes
    AnyShouldWrapper
  52. def shouldBe(spread: Spread[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldBe 7.1 +- 0.2
           ^
    

    Definition Classes
    AnyShouldWrapper
  53. def shouldBe(beMatcher: BeMatcher[String]): Unit

    This method enables the following syntax, where odd refers to a BeMatcher[Int]:

    This method enables the following syntax, where odd refers to a BeMatcher[Int]:

    testing
    1 shouldBe odd
      ^
    

    Definition Classes
    AnyShouldWrapper
  54. def shouldBe(comparison: ResultOfGreaterThanOrEqualToComparison[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    8 shouldBe >= (7)
      ^
    

    Definition Classes
    AnyShouldWrapper
  55. def shouldBe(comparison: ResultOfLessThanOrEqualToComparison[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    5 shouldBe <= (7)
      ^
    

    Definition Classes
    AnyShouldWrapper
  56. def shouldBe(comparison: ResultOfGreaterThanComparison[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    8 shouldBe > (7)
      ^
    

    Definition Classes
    AnyShouldWrapper
  57. def shouldBe(comparison: ResultOfLessThanComparison[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    5 shouldBe < (7)
      ^
    

    Definition Classes
    AnyShouldWrapper
  58. def shouldBe(right: Any): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    aDouble shouldBe 8.8
            ^
    

    Definition Classes
    AnyShouldWrapper
  59. def shouldEqual(right: Null)(implicit ev: <:<[String, AnyRef]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldEqual null
           ^
    

    Definition Classes
    AnyShouldWrapper
  60. def shouldEqual(spread: Spread[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldEqual 7.1 +- 0.2
           ^
    

    Definition Classes
    AnyShouldWrapper
  61. def shouldEqual(right: Any)(implicit equality: Equality[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    a shouldEqual b
      ^
    

    Definition Classes
    AnyShouldWrapper
  62. def shouldNot(includeWord: IncludeWord): ResultOfIncludeWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string shouldNot include regex ("hi")
           ^
    

  63. def shouldNot(endWithWord: EndWithWord): ResultOfEndWithWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string shouldNot endWith regex ("world")
           ^
    

  64. def shouldNot(startWithWord: StartWithWord): ResultOfStartWithWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string shouldNot startWith regex ("hello")
           ^
    

  65. def shouldNot(fullyMatchWord: FullyMatchWord): ResultOfFullyMatchWordForString

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  66. def shouldNot(existWord: ExistWord)(implicit existence: Existence[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    file shouldNot exist
         ^
    

    Definition Classes
    AnyShouldWrapper
  67. def shouldNot(contain: ContainWord): ResultOfContainWord[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    xs shouldNot contain (oneOf (1, 2, 3))
       ^
    

    Definition Classes
    AnyShouldWrapper
  68. def shouldNot(haveWord: HaveWord): ResultOfHaveWordForExtent[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldNot have length (3)
           
    result shouldNot have size (3)
           
    exception shouldNot have message ("file not found")
              ^
    

    Definition Classes
    AnyShouldWrapper
  69. def shouldNot[TYPECLASS1[_]](rightMatcherFactory1: MatcherFactory1[String, TYPECLASS1])(implicit typeClass1: TYPECLASS1[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldNot (be readable)
           ^
    

    Definition Classes
    AnyShouldWrapper
  70. def shouldNot(rightMatcherX1: Matcher[String]): Unit

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldNot (be (3))
           ^
    

    Definition Classes
    AnyShouldWrapper
  71. def shouldNot(beWord: BeWord): ResultOfBeWordForAny[String]

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result shouldNot be (3)
           ^
    

    Definition Classes
    AnyShouldWrapper
  72. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  73. def toString(): String

    Definition Classes
    AnyRef → Any
  74. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  75. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  76. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  77. def withGroup(group: String): RegexWithGroups

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should fullyMatch regex ("a(b*)c" withGroup "bb")
                                             ^
    

  78. def withGroups(groups: String*): RegexWithGroups

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string should fullyMatch regex ("a(b*)(c*)" withGroups ("bb", "cc"))
                                                ^
    

Inherited from Matchers.StringShouldWrapperForVerb

Inherited from AnyShouldWrapper[String]

Inherited from AnyRef

Inherited from Any

Ungrouped