Class

org.scalatest.matchers.must.Matchers

StringMustWrapper

Related Doc: package Matchers

Permalink

final class StringMustWrapper extends AnyMustWrapper[String] with StringMustWrapperForVerb

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 must methods to be invoked on Strings.

Source
Matchers.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringMustWrapper
  2. StringMustWrapperForVerb
  3. AnyMustWrapper
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StringMustWrapper(leftSideString: String, pos: Position, prettifier: Prettifier)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  12. val leftSideString: String

    Permalink
  13. val leftSideValue: String

    Permalink
    Definition Classes
    AnyMustWrapper
  14. macro def must(compileWord: CompileWord)(implicit pos: Position): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string must compile
           ^
    

  15. def must(fullyMatchWord: FullyMatchWord): ResultOfFullyMatchWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  16. def must(resultOfAfterWordApplication: ResultOfAfterWordApplication)(implicit swawr: SubjectWithAfterWordRegistration): Unit

    Permalink

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

    Definition Classes
    StringMustWrapperForVerb
  17. def must(right: ⇒ Unit)(implicit fun: StringVerbBlockRegistration): Unit

    Permalink

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

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

    Definition Classes
    StringMustWrapperForVerb
  18. def must(right: BehaveWord)(implicit svbli: StringVerbBehaveLikeInvocation): BehaveWord

    Permalink

    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)" must 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 leftSideString, and returns the result.

    Definition Classes
    StringMustWrapperForVerb
  19. def must(right: String)(implicit svsi: StringVerbStringInvocation): ResultOfStringPassedToVerb

    Permalink

    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)" must "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 leftSideString, the verb string "must", and right, and returns the result.

    Definition Classes
    StringMustWrapperForVerb
  20. def must(endWithWord: EndWithWord)(implicit ev: <:<[String, String]): ResultOfEndWithWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string must endWith regex ("world")
           ^
    

    Definition Classes
    AnyMustWrapper
  21. def must(startWithWord: StartWithWord)(implicit ev: <:<[String, String]): ResultOfStartWithWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string must startWith regex ("hello")
           ^
    

    Definition Classes
    AnyMustWrapper
  22. def must(includeWord: IncludeWord)(implicit ev: <:<[String, String]): ResultOfIncludeWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string must include regex ("hi")
           ^
    

    Definition Classes
    AnyMustWrapper
  23. def must(notExist: ResultOfNotExist)(implicit existence: Existence[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    file must not (exist)
         ^
    

    Definition Classes
    AnyMustWrapper
  24. def must(existWord: ExistWord)(implicit existence: Existence[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    file must exist
         ^
    

    Definition Classes
    AnyMustWrapper
  25. def must(containWord: ContainWord): ResultOfContainWord[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

    Definition Classes
    AnyMustWrapper
  26. def must(haveWord: HaveWord): ResultOfHaveWordForExtent[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must have length (3)
           ^
    result must have size (3)
           ^
    

    Definition Classes
    AnyMustWrapper
  27. def must(beWord: BeWord): ResultOfBeWordForAny[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must be a aMatcher
           ^
    

    Definition Classes
    AnyMustWrapper
  28. def must(inv: TripleEqualsInvocationOnSpread[String])(implicit ev: Numeric[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

    Definition Classes
    AnyMustWrapper
  29. def must[U](inv: TripleEqualsInvocation[U])(implicit constraint: CanEqual[String, U]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    a must === (b)
           ^
    

    Definition Classes
    AnyMustWrapper
  30. def must(notWord: NotWord): ResultOfNotWordForAny[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must not equal (3)
           ^
    

    Definition Classes
    AnyMustWrapper
  31. def must[TYPECLASS1[_], TYPECLASS2[_]](rightMatcherFactory2: MatcherFactory2[String, TYPECLASS1, TYPECLASS2])(implicit typeClass1: TYPECLASS1[String], typeClass2: TYPECLASS2[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

    Definition Classes
    AnyMustWrapper
  32. def must[TYPECLASS1[_]](rightMatcherFactory1: MatcherFactory1[String, TYPECLASS1])(implicit typeClass1: TYPECLASS1[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must equal (3)
           ^
    

    Definition Classes
    AnyMustWrapper
  33. def must(rightMatcherX1: Matcher[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result must be (3)
           ^
    

    Definition Classes
    AnyMustWrapper
  34. def mustBe[U >: String](resultOfAnWordApplication: ResultOfAnWordToBePropertyMatcherApplication[U])(implicit ev: <:<[String, AnyRef]): Assertion

    Permalink

    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 mustBe an (excellentRead)
                       ^
    

    Definition Classes
    AnyMustWrapper
  35. def mustBe[U >: String](resultOfAWordApplication: ResultOfAWordToBePropertyMatcherApplication[U])(implicit ev: <:<[String, AnyRef]): Assertion

    Permalink

    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 mustBe a (goodRead)
                       ^
    

    Definition Classes
    AnyMustWrapper
  36. def mustBe(bePropertyMatcher: BePropertyMatcher[String])(implicit ev: <:<[String, AnyRef]): Assertion

    Permalink

    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 mustBe excellentRead
                       ^
    

    Definition Classes
    AnyMustWrapper
  37. def mustBe(resultOfSameInstanceAsApplication: ResultOfTheSameInstanceAsApplication)(implicit toAnyRef: <:<[String, AnyRef]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe theSameInstanceAs (anotherObject)
           ^
    

    Definition Classes
    AnyMustWrapper
  38. def mustBe(right: Null)(implicit ev: <:<[String, AnyRef]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe null
           ^
    

    Definition Classes
    AnyMustWrapper
  39. def mustBe(right: DefinedWord)(implicit definition: Definition[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe defined
           ^
    

    Definition Classes
    AnyMustWrapper
  40. def mustBe(right: EmptyWord)(implicit emptiness: Emptiness[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe empty
           ^
    

    Definition Classes
    AnyMustWrapper
  41. def mustBe(right: WritableWord)(implicit writability: Writability[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe writable
           ^
    

    Definition Classes
    AnyMustWrapper
  42. def mustBe(right: ReadableWord)(implicit readability: Readability[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe readable
           ^
    

    Definition Classes
    AnyMustWrapper
  43. macro def mustBe(anType: ResultOfAnTypeInvocation[_]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    aDouble mustBe an [Book]
            ^
    

    Definition Classes
    AnyMustWrapper
  44. macro def mustBe(aType: ResultOfATypeInvocation[_]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    aDouble mustBe a [Book]
            ^
    

    Definition Classes
    AnyMustWrapper
  45. def mustBe(right: SortedWord)(implicit sortable: Sortable[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe sorted
           ^
    

    Definition Classes
    AnyMustWrapper
  46. def mustBe(spread: Spread[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustBe 7.1 +- 0.2
           ^
    

    Definition Classes
    AnyMustWrapper
  47. def mustBe(beMatcher: BeMatcher[String]): Assertion

    Permalink

    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 mustBe odd
      ^
    

    Definition Classes
    AnyMustWrapper
  48. def mustBe(comparison: ResultOfGreaterThanOrEqualToComparison[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    8 mustBe >= (7)
      ^
    

    Definition Classes
    AnyMustWrapper
  49. def mustBe(comparison: ResultOfLessThanOrEqualToComparison[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    5 mustBe <= (7)
      ^
    

    Definition Classes
    AnyMustWrapper
  50. def mustBe(comparison: ResultOfGreaterThanComparison[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    8 mustBe > (7)
      ^
    

    Definition Classes
    AnyMustWrapper
  51. def mustBe(comparison: ResultOfLessThanComparison[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    5 mustBe < (7)
      ^
    

    Definition Classes
    AnyMustWrapper
  52. def mustBe(right: Any): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    aDouble mustBe 8.8
            ^
    

    Definition Classes
    AnyMustWrapper
  53. def mustEqual(right: Null)(implicit ev: <:<[String, AnyRef]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustEqual null
           ^
    

    Definition Classes
    AnyMustWrapper
  54. def mustEqual(spread: Spread[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustEqual 7.1 +- 0.2
           ^
    

    Definition Classes
    AnyMustWrapper
  55. def mustEqual(right: Any)(implicit equality: Equality[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    a mustEqual b
      ^
    

    Definition Classes
    AnyMustWrapper
  56. macro def mustNot(typeCheckWord: TypeCheckWord)(implicit pos: Position): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string mustNot typeCheck
           ^
    

  57. macro def mustNot(compileWord: CompileWord)(implicit pos: Position): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string mustNot compile
           ^
    

  58. def mustNot(fullyMatchWord: FullyMatchWord): ResultOfFullyMatchWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

  59. def mustNot(includeWord: IncludeWord)(implicit ev: <:<[String, String]): ResultOfIncludeWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string mustNot include regex ("hi")
           ^
    

    Definition Classes
    AnyMustWrapper
  60. def mustNot(endWithWord: EndWithWord)(implicit ev: <:<[String, String]): ResultOfEndWithWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string mustNot endWith regex ("world")
           ^
    

    Definition Classes
    AnyMustWrapper
  61. def mustNot(startWithWord: StartWithWord)(implicit ev: <:<[String, String]): ResultOfStartWithWordForString

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    string mustNot startWith regex ("hello")
           ^
    

    Definition Classes
    AnyMustWrapper
  62. def mustNot(existWord: ExistWord)(implicit existence: Existence[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    file mustNot exist
         ^
    

    Definition Classes
    AnyMustWrapper
  63. def mustNot(contain: ContainWord): ResultOfContainWord[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

    Definition Classes
    AnyMustWrapper
  64. def mustNot(haveWord: HaveWord): ResultOfHaveWordForExtent[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

    Definition Classes
    AnyMustWrapper
  65. def mustNot[TYPECLASS1[_]](rightMatcherFactory1: MatcherFactory1[String, TYPECLASS1])(implicit typeClass1: TYPECLASS1[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustNot (be readable)
           ^
    

    Definition Classes
    AnyMustWrapper
  66. def mustNot(rightMatcherX1: Matcher[String]): Assertion

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustNot (be (3))
           ^
    

    Definition Classes
    AnyMustWrapper
  67. def mustNot(beWord: BeWord): ResultOfBeWordForAny[String]

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

    result mustNot be (3)
           ^
    

    Definition Classes
    AnyMustWrapper
  68. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  69. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  70. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  71. val pos: Position

    Permalink
    Definition Classes
    AnyMustWrapper
  72. val prettifier: Prettifier

    Permalink
    Definition Classes
    AnyMustWrapper
  73. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  74. def toString(): String

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

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

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

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

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

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

    Permalink

    This method enables syntax such as the following:

    This method enables syntax such as the following:

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

Inherited from AnyMustWrapper[String]

Inherited from AnyRef

Inherited from Any

Ungrouped