o

scalachecklib

GeneratorsSection

object GeneratorsSection extends Checkers with Matchers with Section

Generators are responsible for generating test data in ScalaCheck, and are represented by the org.scalacheck.Gen class. ou need to know how to use this class if you want ScalaCheck to generate data of types that are not supported by default, or if you want to use the forAll method mentioned above, to state properties about a specific subset of a type. In the Gen object, there are several methods for creating new and modifying existing generators. We will show how to use some of them in this section. For a more complete reference of what is available, please see the API scaladoc.

A generator can be seen simply as a function that takes some generation parameters, and (maybe) returns a generated value. That is, the type Gen[T] may be thought of as a function of type Gen.Params => Option[T]. However, the Gen class contains additional methods to make it possible to map generators, use them in for-comprehensions and so on. Conceptually, though, you should think of generators simply as functions, and the combinators in the Gen object can be used to create or modify the behaviour of such generator functions.

Linear Supertypes
Section, Matchers, Explicitly, MatcherWords, ShouldVerb, Tolerance, Assertions, TripleEquals, TripleEqualsSupport, Checkers, ScalaCheckConfiguration, Configuration, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneratorsSection
  2. Section
  3. Matchers
  4. Explicitly
  5. MatcherWords
  6. ShouldVerb
  7. Tolerance
  8. Assertions
  9. TripleEquals
  10. TripleEqualsSupport
  11. Checkers
  12. ScalaCheckConfiguration
  13. Configuration
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class AWord extends AnyRef
    Definition Classes
    Matchers
  2. final class AnWord extends AnyRef
    Definition Classes
    Matchers
  3. sealed class AnyShouldWrapper[T] extends AnyRef
    Definition Classes
    Matchers
  4. class CheckingEqualizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  5. sealed class Collected extends Serializable
    Attributes
    protected
    Definition Classes
    Matchers
  6. class DecidedByEquality[A] extends Equality[A]
    Definition Classes
    Explicitly
  7. class DecidedWord extends AnyRef
    Definition Classes
    Explicitly
  8. class DeterminedByEquivalence[T] extends Equivalence[T]
    Definition Classes
    Explicitly
  9. class DeterminedWord extends AnyRef
    Definition Classes
    Explicitly
  10. class Equalizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  11. final class HavePropertyMatcherGenerator extends AnyRef
    Definition Classes
    Matchers
  12. final class KeyWord extends AnyRef
    Definition Classes
    Matchers
  13. case class MaxDiscardedFactor extends PropertyCheckConfigParam with Product with Serializable
    Definition Classes
    Configuration
  14. case class MinSize extends PropertyCheckConfigParam with Product with Serializable
    Definition Classes
    Configuration
  15. case class MinSuccessful extends PropertyCheckConfigParam with Product with Serializable
    Definition Classes
    Configuration
  16. final class PlusOrMinusWrapper[T] extends AnyRef
    Definition Classes
    Tolerance
  17. sealed abstract class PropertyCheckConfigParam extends Product with Serializable
    Definition Classes
    Configuration
  18. case class PropertyCheckConfiguration extends Product with Serializable
    Definition Classes
    Configuration
  19. final class RegexWord extends AnyRef
    Definition Classes
    Matchers
  20. final class RegexWrapper extends AnyRef
    Definition Classes
    Matchers
  21. class ResultOfBeWordForAny[T] extends AnyRef
    Definition Classes
    Matchers
  22. sealed class ResultOfBeWordForCollectedAny[T] extends AnyRef
    Definition Classes
    Matchers
  23. final class ResultOfBeWordForCollectedArray[T] extends ResultOfBeWordForCollectedAny[Array[T]]
    Definition Classes
    Matchers
  24. final class ResultOfCollectedAny[T] extends AnyRef
    Definition Classes
    Matchers
  25. final class ResultOfContainWordForCollectedAny[T] extends AnyRef
    Definition Classes
    Matchers
  26. final class ResultOfEndWithWordForCollectedString extends AnyRef
    Definition Classes
    Matchers
  27. final class ResultOfEndWithWordForString extends AnyRef
    Definition Classes
    Matchers
  28. final class ResultOfFullyMatchWordForCollectedString extends AnyRef
    Definition Classes
    Matchers
  29. final class ResultOfFullyMatchWordForString extends AnyRef
    Definition Classes
    Matchers
  30. final class ResultOfHaveWordForCollectedExtent[A] extends AnyRef
    Definition Classes
    Matchers
  31. final class ResultOfHaveWordForExtent[A] extends AnyRef
    Definition Classes
    Matchers
  32. final class ResultOfIncludeWordForCollectedString extends AnyRef
    Definition Classes
    Matchers
  33. final class ResultOfIncludeWordForString extends AnyRef
    Definition Classes
    Matchers
  34. final class ResultOfNotWordForCollectedAny[T] extends AnyRef
    Definition Classes
    Matchers
  35. final class ResultOfStartWithWordForCollectedString extends AnyRef
    Definition Classes
    Matchers
  36. final class ResultOfStartWithWordForString extends AnyRef
    Definition Classes
    Matchers
  37. case class SizeRange extends PropertyCheckConfigParam with Product with Serializable
    Definition Classes
    Configuration
  38. final class StringShouldWrapper extends AnyShouldWrapper[String] with org.scalatest.matchers.should.Matchers.StringShouldWrapperForVerb
    Definition Classes
    Matchers
  39. trait StringShouldWrapperForVerb extends AnyRef
    Definition Classes
    ShouldVerb
  40. class TheAfterWord extends AnyRef
    Definition Classes
    Explicitly
  41. final class TheSameInstanceAsPhrase extends AnyRef
    Definition Classes
    Matchers
  42. final class ValueWord extends AnyRef
    Definition Classes
    Matchers
  43. case class Workers extends PropertyCheckConfigParam with Product with Serializable
    Definition Classes
    Configuration

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. def <[T](right: T)(implicit arg0: Ordering[T]): ResultOfLessThanComparison[T]
    Definition Classes
    Matchers
  7. def <=[T](right: T)(implicit arg0: Ordering[T]): ResultOfLessThanOrEqualToComparison[T]
    Definition Classes
    Matchers
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  10. def ===(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  11. def ===[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  12. def >[T](right: T)(implicit arg0: Ordering[T]): ResultOfGreaterThanComparison[T]
    Definition Classes
    Matchers
  13. def >=[T](right: T)(implicit arg0: Ordering[T]): ResultOfGreaterThanOrEqualToComparison[T]
    Definition Classes
    Matchers
  14. def a[T](implicit arg0: ClassTag[T]): ResultOfATypeInvocation[T]
    Definition Classes
    Matchers
  15. val a: AWord
    Definition Classes
    Matchers
  16. val after: TheAfterWord
    Definition Classes
    Explicitly
  17. def all(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  18. def all[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  19. def all[K, V, MAP[k, v] <: GenMap[k, v]](xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
    Definition Classes
    Matchers
  20. def all[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  21. def allElementsOf[R](elements: GenTraversable[R]): ResultOfAllElementsOfApplication
    Definition Classes
    Matchers
  22. def allOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAllOfApplication
    Definition Classes
    Matchers
  23. def an[T](implicit arg0: ClassTag[T]): ResultOfAnTypeInvocation[T]
    Definition Classes
    Matchers
  24. val an: AnWord
    Definition Classes
    Matchers
  25. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  26. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  27. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  28. macro def assertCompiles(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  29. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  30. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  31. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  32. def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
    Definition Classes
    Assertions
  33. macro def assertTypeError(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  34. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  35. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  36. def atLeast(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  37. def atLeast[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  38. def atLeast[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
    Definition Classes
    Matchers
  39. def atLeast[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  40. def atLeastOneElementOf(elements: GenTraversable[Any]): ResultOfAtLeastOneElementOfApplication
    Definition Classes
    Matchers
  41. def atLeastOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAtLeastOneOfApplication
    Definition Classes
    Matchers
  42. def atMost(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  43. def atMost[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  44. def atMost[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
    Definition Classes
    Matchers
  45. def atMost[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  46. def atMostOneElementOf[R](elements: GenTraversable[R]): ResultOfAtMostOneElementOfApplication
    Definition Classes
    Matchers
  47. def atMostOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAtMostOneOfApplication
    Definition Classes
    Matchers
  48. val be: BeWord
    Definition Classes
    MatcherWords
  49. def between(from: Int, upTo: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  50. def between[K, V, JMAP[k, v] <: Map[k, v]](from: Int, upTo: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  51. def between[E, C[_]](from: Int, upTo: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  52. def cancel(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  53. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  54. def cancel(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  55. def cancel()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  56. def caseClassGenerator(res0: Boolean): Assertion

    On the basis of the above we can create a generator for the following case class:

    Case class Generators

    On the basis of the above we can create a generator for the following case class:

    case class Foo(intValue: Int, charValue: Char)
  57. def check(p: Prop, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  58. def check(p: Prop, prms: Parameters)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  59. def check[A1, A2, A3, A4, A5, A6, P](f: (A1, A2, A3, A4, A5, A6) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) => Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) => Pretty, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  60. def check[A1, A2, A3, A4, A5, P](f: (A1, A2, A3, A4, A5) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) => Pretty, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  61. def check[A1, A2, A3, A4, P](f: (A1, A2, A3, A4) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  62. def check[A1, A2, A3, P](f: (A1, A2, A3) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  63. def check[A1, A2, P](f: (A1, A2) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  64. def check[A1, P](f: (A1) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfiguration, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Checkers
  65. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  66. val compile: CompileWord
    Definition Classes
    MatcherWords
  67. def conditionalOperators(res0: Int): Assertion

    Conditional generators can be defined using Gen.suchThat.

    Conditional Generators

    Conditional generators can be defined using Gen.suchThat.

    Conditional generators works just like conditional properties, in the sense that if the condition is too hard, ScalaCheck might not be able to generate enough values, and it might report a property test as undecided. The smallEvenInteger definition is probably OK, since it will only throw away half of the generated numbers, but one has to be careful when using the suchThat operator.

  68. val contain: ContainWord
    Definition Classes
    MatcherWords
  69. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  70. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  71. implicit def convertNumericToPlusOrMinusWrapper[T](pivot: T)(implicit arg0: Numeric[T]): PlusOrMinusWrapper[T]
    Definition Classes
    Tolerance
  72. implicit def convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol)(implicit prettifier: Prettifier, pos: Position): HavePropertyMatcherGenerator
    Definition Classes
    Matchers
  73. implicit def convertToAnyShouldWrapper[T](o: T)(implicit pos: Position, prettifier: Prettifier): AnyShouldWrapper[T]
    Definition Classes
    Matchers
  74. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  75. implicit def convertToEqualizer[T](left: T): Equalizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  76. implicit def convertToRegexWrapper(o: Regex): RegexWrapper
    Definition Classes
    Matchers
  77. implicit def convertToStringShouldWrapper(o: String)(implicit pos: Position, prettifier: Prettifier): StringShouldWrapper
    Definition Classes
    Matchers
  78. implicit def convertToStringShouldWrapperForVerb(o: String)(implicit position: Position): StringShouldWrapperForVerb
    Definition Classes
    ShouldVerb
  79. val decided: DecidedWord
    Definition Classes
    Explicitly
  80. def defaultEquality[A]: Equality[A]
    Definition Classes
    TripleEqualsSupport
  81. val defined: DefinedWord
    Definition Classes
    MatcherWords
  82. def definedAt[T](right: T): ResultOfDefinedAt[T]
    Definition Classes
    Matchers
  83. val determined: DeterminedWord
    Definition Classes
    Explicitly
  84. val empty: EmptyWord
    Definition Classes
    MatcherWords
  85. val endWith: EndWithWord
    Definition Classes
    MatcherWords
  86. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  87. def equal(o: Null): Matcher[AnyRef]
    Definition Classes
    Matchers
  88. def equal[T](spread: Spread[T]): Matcher[T]
    Definition Classes
    Matchers
  89. def equal(right: Any): MatcherFactory1[Any, Equality]
    Definition Classes
    MatcherWords
  90. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  91. def every(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  92. def every[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  93. def every[K, V, MAP[k, v] <: Map[k, v]](xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
    Definition Classes
    Matchers
  94. def every[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  95. def exactly(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  96. def exactly[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  97. def exactly[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
    Definition Classes
    Matchers
  98. def exactly[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  99. val exist: ExistWord
    Definition Classes
    MatcherWords
  100. def fail(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  101. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  102. def fail(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  103. def fail()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  104. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  105. def forComprehension(res0: Boolean): Assertion

    Let's see how to create a new generator.

    Let's see how to create a new generator. The best way to do it is to use the generator combinators that exist in the org.scalacheck.Gen module. These can be combined using a for-comprehension. Suppose you need a generator which generates a tuple that contains two random integer values, one of them being at least twice as big as the other. The following definition does this:

  106. val fullyMatch: FullyMatchWord
    Definition Classes
    MatcherWords
  107. def genAPI(res0: Boolean, res1: Boolean, res2: Int): Assertion

    The distribution is uniform, but if you want to control it you can use the frequency combinator:

    The distribution is uniform, but if you want to control it you can use the frequency combinator:

    val vowel = Gen.frequency(
  (3, 'A'),
  (4, 'E'),
  (2, 'I'),
  (3, 'O'),
  (1, 'U')
)

    Now, the vowel generator will generate E:s more often than U:s. Roughly, 4/14 of the values generated will be E:s, and 1/14 of them will be U:s.

    Other methods in the Gen API:

    def alphaChar: Gen[Char]

def alphaStr: Gen[String]

def posNum[T](implicit n: Numeric[T]): Gen[T]

def listOf[T](g: Gen[T]): Gen[List[T]]

def listOfN[T](n: Int, g: Gen[T]): Gen[List[T]]
  108. def genOf(res0: Seq[Char]): Assertion

    You can create generators that pick one value out of a selection of values.

    You can create generators that pick one value out of a selection of values. The oneOf method creates a generator that randomly picks one of its parameters each time it generates a value. Notice that plain values are implicitly converted to generators (which always generate that value) if needed.

    The following generator generates a vowel:

  109. def generatingContainers(res0: List[Int]): Assertion

    There is a special generator, Gen.containerOf, that generates containers such as lists and arrays.

    Generating Containers

    There is a special generator, Gen.containerOf, that generates containers such as lists and arrays. It takes another generator as argument which is responsible for generating the individual items. You can use it in the following way:

    val genIntList      = Gen.containerOf[List,Int](Gen.oneOf(1, 3, 5))

val genStringStream = Gen.containerOf[LazyList,String](Gen.alphaStr)

val genBoolArray    = Gen.containerOf[Array,Boolean](true)

    By default, ScalaCheck supports generation of List, Stream (Scala 2.10 - 2.12, deprecated in 2.13), LazyList (Scala 2.13), Set, Array, and ArrayList (from java.util). You can add support for additional containers by adding implicit Buildable instances. See Buildable.scala for examples.

    There is also Gen.nonEmptyContainerOf for generating non-empty containers, and Gen.containerOfN for generating containers of a given size.

  110. implicit val generatorDrivenConfig: PropertyCheckConfiguration
    Definition Classes
    Configuration
  111. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  112. def getParameter(configParams: Seq[PropertyCheckConfigParam], config: PropertyCheckConfiguration): Parameter
    Definition Classes
    Configuration
  113. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  114. val have: HaveWord
    Definition Classes
    MatcherWords
  115. def inOrder(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfInOrderApplication
    Definition Classes
    Matchers
  116. def inOrderElementsOf[R](elements: GenTraversable[R]): ResultOfInOrderElementsOfApplication
    Definition Classes
    Matchers
  117. def inOrderOnly[T](firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfInOrderOnlyApplication
    Definition Classes
    Matchers
  118. val include: IncludeWord
    Definition Classes
    MatcherWords
  119. def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
    Definition Classes
    Assertions
  120. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  121. val key: KeyWord
    Definition Classes
    Matchers
  122. val length: LengthWord
    Definition Classes
    MatcherWords
  123. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  124. val matchPattern: MatchPatternWord
    Definition Classes
    MatcherWords
  125. def maxDiscardedFactor(value: PosZDouble): MaxDiscardedFactor
    Definition Classes
    Configuration
  126. def message(expectedMessage: String): ResultOfMessageWordApplication
    Definition Classes
    Matchers
  127. def minSize(value: PosZInt): MinSize
    Definition Classes
    Configuration
  128. def minSuccessful(value: PosInt): MinSuccessful
    Definition Classes
    Configuration
  129. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  130. def no(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
    Definition Classes
    Matchers
  131. def no[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
    Definition Classes
    Matchers
  132. def no[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
    Definition Classes
    Matchers
  133. def noElementsOf(elements: GenTraversable[Any]): ResultOfNoElementsOfApplication
    Definition Classes
    Matchers
  134. def noException(implicit pos: Position): NoExceptionWord
    Definition Classes
    MatcherWords
  135. def noneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfNoneOfApplication
    Definition Classes
    Matchers
  136. val not: NotWord
    Definition Classes
    MatcherWords
  137. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  138. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  139. def of[T](implicit ev: ClassTag[T]): ResultOfOfTypeInvocation[T]
    Definition Classes
    Matchers
  140. def oneElementOf(elements: GenTraversable[Any]): ResultOfOneElementOfApplication
    Definition Classes
    Matchers
  141. def oneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfOneOfApplication
    Definition Classes
    Matchers
  142. def only(xs: Any*)(implicit pos: Position): ResultOfOnlyApplication
    Definition Classes
    Matchers
  143. def pending: Assertion with PendingStatement
    Definition Classes
    Assertions
  144. def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
    Definition Classes
    Assertions
  145. val readable: ReadableWord
    Definition Classes
    MatcherWords
  146. val regex: RegexWord
    Definition Classes
    Matchers
  147. val size: SizeWord
    Definition Classes
    MatcherWords
  148. def sizeRange(value: PosZInt): SizeRange
    Definition Classes
    Configuration
  149. def sizedGenerator(res0: Int, res1: Int): Assertion

    When ScalaCheck uses a generator to generate a value, it feeds it with some parameters.

    Sized Generators

    When ScalaCheck uses a generator to generate a value, it feeds it with some parameters. One of the parameters the generator is given is a size value, which some generators use to generate their values.

    If you want to use the size parameter in your own generator, you can use the Gen.sized method:

    def sized[T](f: Int => Gen[T])

    In this example we're creating a generator that produces two lists of numbers where 1/3 are positive and 2/3 are negative. Note: we're also returning the original size to verify the behaviour.

  150. val sorted: SortedWord
    Definition Classes
    MatcherWords
  151. val startWith: StartWithWord
    Definition Classes
    MatcherWords
  152. final val succeed: Assertion
    Definition Classes
    Assertions
  153. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  154. def the[T](implicit arg0: ClassTag[T], pos: Position): ResultOfTheTypeInvocation[T]
    Definition Classes
    Matchers
  155. def theSameElementsAs(xs: GenTraversable[_]): ResultOfTheSameElementsAsApplication
    Definition Classes
    Matchers
  156. def theSameElementsInOrderAs(xs: GenTraversable[_]): ResultOfTheSameElementsInOrderAsApplication
    Definition Classes
    Matchers
  157. val theSameInstanceAs: TheSameInstanceAsPhrase
    Definition Classes
    Matchers
  158. def thrownBy(fun: => Any): ResultOfThrownByApplication
    Definition Classes
    Matchers
  159. def toString(): String
    Definition Classes
    AnyRef → Any
  160. val typeCheck: TypeCheckWord
    Definition Classes
    MatcherWords
  161. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  162. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  163. val value: ValueWord
    Definition Classes
    Matchers
  164. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  165. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  166. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  167. def withClue[T](clue: Any)(fun: => T): T
    Definition Classes
    Assertions
  168. def workers(value: PosInt): Workers
    Definition Classes
    Configuration
  169. val writable: WritableWord
    Definition Classes
    MatcherWords

Deprecated Value Members

  1. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) => A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  2. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) => B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  3. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) => A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  4. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) => B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Inherited from Section

Inherited from Matchers

Inherited from Explicitly

Inherited from MatcherWords

Inherited from ShouldVerb

Inherited from Tolerance

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from Checkers

Inherited from ScalaCheckConfiguration

Inherited from Configuration

Inherited from AnyRef

Inherited from Any

Ungrouped