org.scalatest.prop

GeneratorDrivenPropertyChecks

object GeneratorDrivenPropertyChecks extends GeneratorDrivenPropertyChecks

go to: companion
linear super types: GeneratorDrivenPropertyChecks, Configuration, Whenever, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. GeneratorDrivenPropertyChecks
  2. GeneratorDrivenPropertyChecks
  3. Configuration
  4. Whenever
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. class ConfiguredPropertyCheck extends AnyRef

    Performs a configured property checks by applying property check functions passed to its apply methods to arguments supplied by implicitly passed generators, modifying the values in the PropertyGenConfig object passed implicitly to its apply methods with parameter values passed to its constructor.

  2. case class MaxDiscarded ( value : Int ) extends PropertyCheckConfigParam with Product with Serializable

    A PropertyCheckConfigParam that specifies the maximum number of discarded property evaluations allowed during property evaluation.

  3. case class MaxSize ( value : Int ) extends PropertyCheckConfigParam with Product with Serializable

    A PropertyCheckConfigParam that specifies the maximum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

  4. case class MinSize ( value : Int ) extends PropertyCheckConfigParam with Product with Serializable

    A PropertyCheckConfigParam that specifies the minimum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

  5. case class MinSuccessful ( value : Int ) extends PropertyCheckConfigParam with Product with Serializable

    A PropertyCheckConfigParam that specifies the minimum number of successful property evaluations required for the property to pass.

  6. case class PropertyCheckConfig ( minSuccessful : Int , maxDiscarded : Int , minSize : Int , maxSize : Int , workers : Int ) extends Product with Serializable

    Configuration object for property checks.

  7. class PropertyCheckConfigParam extends AnyRef

    Abstract class defining a family of configuration parameters for property checks.

  8. case class Workers ( value : Int ) extends PropertyCheckConfigParam with Product with Serializable

    A PropertyCheckConfigParam that specifies the number of worker threads to use when evaluating a property.

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. object MaxDiscarded extends AbstractFunction1[Int, MaxDiscarded] with Serializable

  9. object MaxSize extends AbstractFunction1[Int, MaxSize] with Serializable

  10. object MinSize extends AbstractFunction1[Int, MinSize] with Serializable

  11. object MinSuccessful extends AbstractFunction1[Int, MinSuccessful] with Serializable

  12. object PropertyCheckConfig extends AbstractFunction5[Int, Int, Int, Int, Int, PropertyCheckConfig] with Serializable

  13. object Workers extends AbstractFunction1[Int, Workers] with Serializable

  14. 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
  15. 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()
  16. 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
  17. 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
  18. 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()
  19. def forAll [A, B, C, D, E, F] ( genAndNameA : (Gen[A], String) , genAndNameB : (Gen[B], String) , genAndNameC : (Gen[C], String) , genAndNameD : (Gen[D], String) , genAndNameE : (Gen[E], String) , genAndNameF : (Gen[F], String) , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D, E, F) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] , shrD : Shrink[D] , shrE : Shrink[E] , shrF : Shrink[F] ) : Unit

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c"), (famousLastWords, "d"), (famousLastWords, "e"), (famousLastWords, "f")) { (a: String, b: String, c: String, d: String, e: String, f: String) => a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  20. def forAll [A, B, C, D, E, F] ( genA : Gen[A] , genB : Gen[B] , genC : Gen[C] , genD : Gen[D] , genE : Gen[E] , genF : Gen[F] , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D, E, F) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] , shrD : Shrink[D] , shrE : Shrink[E] , shrF : Shrink[F] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll (famousLastWords, famousLastWords, famousLastWords, famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String, d: String, e: String, f: String) => a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  21. def forAll [A, B, C, D, E, F] ( nameA : String , nameB : String , nameC : String , nameD : String , nameE : String , nameF : String , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D, E, F) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] , arbD : Arbitrary[D] , shrD : Shrink[D] , arbE : Arbitrary[E] , shrE : Shrink[E] , arbF : Arbitrary[F] , shrF : Shrink[F] ) : Unit

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll ("a", "b", "c", "d", "e", "f") { (a: String, b: String, c: String, d: String, e: String, f: String) =>
      a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  22. def forAll [A, B, C, D, E, F] ( fun : (A, B, C, D, E, F) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] , arbD : Arbitrary[D] , shrD : Shrink[D] , arbE : Arbitrary[E] , shrE : Shrink[E] , arbF : Arbitrary[F] , shrF : Shrink[F] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll { (a: String, b: String, c: String, d: String, e: String, f: String) =>
      a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  23. def forAll [A, B, C, D, E] ( genAndNameA : (Gen[A], String) , genAndNameB : (Gen[B], String) , genAndNameC : (Gen[C], String) , genAndNameD : (Gen[D], String) , genAndNameE : (Gen[E], String) , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D, E) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] , shrD : Shrink[D] , shrE : Shrink[E] ) : Unit

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c"), (famousLastWords, "d"), (famousLastWords, "e")) { (a: String, b: String, c: String, d: String, e: String) => a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  24. def forAll [A, B, C, D, E] ( genA : Gen[A] , genB : Gen[B] , genC : Gen[C] , genD : Gen[D] , genE : Gen[E] , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D, E) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] , shrD : Shrink[D] , shrE : Shrink[E] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll (famousLastWords, famousLastWords, famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String, d: String, e: String) => a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  25. def forAll [A, B, C, D, E] ( nameA : String , nameB : String , nameC : String , nameD : String , nameE : String , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D, E) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] , arbD : Arbitrary[D] , shrD : Shrink[D] , arbE : Arbitrary[E] , shrE : Shrink[E] ) : Unit

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll ("a", "b", "c", "d", "e") { (a: String, b: String, c: String, d: String, e: String) =>
      a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  26. def forAll [A, B, C, D, E] ( fun : (A, B, C, D, E) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] , arbD : Arbitrary[D] , shrD : Shrink[D] , arbE : Arbitrary[E] , shrE : Shrink[E] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll { (a: String, b: String, c: String, d: String, e: String) =>
      a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  27. def forAll [A, B, C, D] ( genAndNameA : (Gen[A], String) , genAndNameB : (Gen[B], String) , genAndNameC : (Gen[C], String) , genAndNameD : (Gen[D], String) , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] , shrD : Shrink[D] ) : Unit

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c"), (famousLastWords, "d")) { (a: String, b: String, c: String, d: String) => a.length + b.length + c.length + d.length should equal ((a + b + c + d).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  28. def forAll [A, B, C, D] ( genA : Gen[A] , genB : Gen[B] , genC : Gen[C] , genD : Gen[D] , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] , shrD : Shrink[D] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll (famousLastWords, famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String, d: String) => a.length + b.length + c.length + d.length should equal ((a + b + c + d).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  29. def forAll [A, B, C, D] ( nameA : String , nameB : String , nameC : String , nameD : String , configParams : PropertyCheckConfigParam* )( fun : (A, B, C, D) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] , arbD : Arbitrary[D] , shrD : Shrink[D] ) : Unit

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll ("a", "b", "c", "d") { (a: String, b: String, c: String, d: String) =>
      a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  30. def forAll [A, B, C, D] ( fun : (A, B, C, D) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] , arbD : Arbitrary[D] , shrD : Shrink[D] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll { (a: String, b: String, c: String, d: String) =>
      a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  31. def forAll [A, B, C] ( genAndNameA : (Gen[A], String) , genAndNameB : (Gen[B], String) , genAndNameC : (Gen[C], String) , configParams : PropertyCheckConfigParam* )( fun : (A, B, C) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] ) : Unit

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c")) { (a: String, b: String, c: String) => a.length + b.length + c.length should equal ((a + b + c).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  32. def forAll [A, B, C] ( genA : Gen[A] , genB : Gen[B] , genC : Gen[C] , configParams : PropertyCheckConfigParam* )( fun : (A, B, C) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] , shrC : Shrink[C] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll (famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String) => a.length + b.length + c.length should equal ((a + b + c).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  33. def forAll [A, B, C] ( nameA : String , nameB : String , nameC : String , configParams : PropertyCheckConfigParam* )( fun : (A, B, C) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] ) : Unit

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll ("a", "b", "c") { (a: String, b: String, c: String) =>
      a.length + b.length + c.length should equal ((a + b + c).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  34. def forAll [A, B, C] ( fun : (A, B, C) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] , arbC : Arbitrary[C] , shrC : Shrink[C] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll { (a: String, b: String, c: String) =>
      a.length + b.length + c.length should equal ((a + b + c).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  35. def forAll [A, B] ( genAndNameA : (Gen[A], String) , genAndNameB : (Gen[B], String) , configParams : PropertyCheckConfigParam* )( fun : (A, B) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] ) : Unit

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll ((famousLastWords, "a"), (famousLastWords, "b")) { (a: String, b: String) => a.length + b.length should equal ((a + b).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  36. def forAll [A, B] ( genA : Gen[A] , genB : Gen[B] , configParams : PropertyCheckConfigParam* )( fun : (A, B) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] , shrB : Shrink[B] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll (famousLastWords, famousLastWords) { (a: String, b: String) => a.length + b.length should equal ((a + b).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  37. def forAll [A, B] ( nameA : String , nameB : String , configParams : PropertyCheckConfigParam* )( fun : (A, B) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] ) : Unit

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll ("a", "b") { (a: String, b: String) =>
      a.length + b.length should equal ((a + b).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  38. def forAll [A, B] ( fun : (A, B) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] , arbB : Arbitrary[B] , shrB : Shrink[B] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll { (a: String, b: String) =>
      a.length + b.length should equal ((a + b).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  39. def forAll [A] ( genAndNameA : (Gen[A], String) , configParams : PropertyCheckConfigParam* )( fun : (A) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] ) : Unit

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll ((famousLastWords, "a")) { (a: String) => a.length should equal ((a).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  40. def forAll [A] ( genA : Gen[A] , configParams : PropertyCheckConfigParam* )( fun : (A) ⇒ Unit )(implicit config : PropertyCheckConfig , shrA : Shrink[A] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

    Here's an example:

    import org.scalacheck.Gen

    // Define your own string generator: val famousLastWords = for { s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work") } yield s

    forAll (famousLastWords) { (a: String) => a.length should equal ((a).length) }

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  41. def forAll [A] ( nameA : String , configParams : PropertyCheckConfigParam* )( fun : (A) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] ) : Unit

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll ("a") { (a: String) =>
      a.length should equal ((a).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  42. def forAll [A] ( fun : (A) ⇒ Unit )(implicit config : PropertyCheckConfig , arbA : Arbitrary[A] , shrA : Shrink[A] ) : Unit

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

    Here's an example:

    forAll { (a: String) =>
      a.length should equal ((a).length)
    }
    

    fun

    the property check function to apply to the generated arguments

    definition classes: GeneratorDrivenPropertyChecks
  43. def forAll ( configParams : PropertyCheckConfigParam* ) : ConfiguredPropertyCheck

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators, modifying the values in the implicitly passed PropertyGenConfig object with explicitly passed parameter values.

    Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators, modifying the values in the implicitly passed PropertyGenConfig object with explicitly passed parameter values.

    This method creates a ConfiguredPropertyCheck object that has six overloaded apply methods that take a function. Thus it is used with functions of all six arities. Here are some examples:

    forAll (minSize(1), maxSize(10)) { (a: String) =>
      a.length should equal ((a).length)
    }

    forAll (minSize(1), maxSize(10)) { (a: String, b: String) => a.length + b.length should equal ((a + b).length) }

    forAll (minSize(1), maxSize(10)) { (a: String, b: String, c: String) => a.length + b.length + c.length should equal ((a + b + c).length) }

    forAll (minSize(1), maxSize(10)) { (a: String, b: String, c: String, d: String) => a.length + b.length + c.length + d.length should equal ((a + b + c + d).length) }

    forAll (minSize(1), maxSize(10)) { (a: String, b: String, c: String, d: String, e: String) => a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length) }

    forAll (minSize(1), maxSize(10)) { (a: String, b: String, c: String, d: String, e: String, f: String) => a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length) }

    configParams

    a variable length list of PropertyCheckConfigParam objects that should override corresponding values in the PropertyCheckConfig implicitly passed to the apply methods of the ConfiguredPropertyCheck object returned by this method.

    definition classes: GeneratorDrivenPropertyChecks
  44. implicit val generatorDrivenConfig : PropertyCheckConfig

    Implicit PropertyCheckConfig value providing default configuration values.

    Implicit PropertyCheckConfig value providing default configuration values.

    attributes: implicit
    definition classes: Configuration
  45. 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
  46. 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
  47. 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
  48. def maxDiscarded ( value : Int ) : MaxDiscarded

    Returns a MaxDiscarded property check configuration parameter containing the passed value, which specifies the maximum number of discarded property evaluations allowed during property evaluation.

    Returns a MaxDiscarded property check configuration parameter containing the passed value, which specifies the maximum number of discarded property evaluations allowed during property evaluation.

    definition classes: Configuration
  49. def maxSize ( value : Int ) : MaxSize

    Returns a MaxSize property check configuration parameter containing the passed value, which specifies the maximum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

    Returns a MaxSize property check configuration parameter containing the passed value, which specifies the maximum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

    Note that the maximum size should be greater than or equal to the minimum size. This requirement is enforced by the PropertyCheckConfig constructor and the forAll methods of traits PropertyChecks and Checkers. In other words, it is enforced at the point both a maximum and minimum size are provided together.

    definition classes: Configuration
  50. def minSize ( value : Int ) : MinSize

    Returns a MinSize property check configuration parameter containing the passed value, which specifies the minimum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

    Returns a MinSize property check configuration parameter containing the passed value, which specifies the minimum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

    definition classes: Configuration
  51. def minSuccessful ( value : Int ) : MinSuccessful

    Returns a MinSuccessful property check configuration parameter containing the passed value, which specifies the minimum number of successful property evaluations required for the property to pass.

    Returns a MinSuccessful property check configuration parameter containing the passed value, which specifies the minimum number of successful property evaluations required for the property to pass.

    definition classes: Configuration
  52. 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
  53. 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
  54. 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
  55. def synchronized [T0] ( arg0 : ⇒ T0 ) : T0

    attributes: final
    definition classes: AnyRef
  56. 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
  57. def wait () : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  58. def wait ( arg0 : Long , arg1 : Int ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  59. def wait ( arg0 : Long ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  60. def whenever ( condition : Boolean )( fun : ⇒ Unit ) : Unit

    Evaluates the passed code block if the passed boolean condition is true, else throws UnmetConditionException.

    Evaluates the passed code block if the passed boolean condition is true, else throws UnmetConditionException.

    The whenever method can be used inside property check functions to discard invocations of the function with data for which it is known the property would fail. For example, given the following Fraction class:

    class Fraction(n: Int, d: Int) {

    require(d != 0) require(d != Integer.MIN_VALUE) require(n != Integer.MIN_VALUE)

    val numer = if (d < 0) -1 * n else n val denom = d.abs

    override def toString = numer + " / " + denom }

    import org.scalatest.prop.TableDrivenPropertyChecks._

    val fractions = Table( ("n", "d"), ( 1, 2), ( -1, 2), ( 1, -2), ( -1, -2), ( 3, 1), ( -3, 1), ( -3, 0), ( 3, -1), ( 3, Integer.MIN_VALUE), (Integer.MIN_VALUE, 3), ( -3, -1) )

    Imagine you wanted to check a property against this class with data that includes some value that are rejected by the constructor, such as a denominator of zero, which should result in an IllegalArgumentException. You could use whenever to discard any rows in the fraction that represent illegal arguments, like this:

    import org.scalatest.matchers.ShouldMatchers._

    forAll (fractions) { (n: Int, d: Int) =>

    whenever (d != 0 && d != Integer.MIN_VALUE && n != Integer.MIN_VALUE) {

    val f = new Fraction(n, d)

    if (n < 0 && d < 0 || n > 0 && d > 0) f.numer should be > 0 else if (n != 0) f.numer should be < 0 else f.numer should be === 0

    f.denom should be > 0 } }

    In this example, rows 6, 8, and 9 have values that would cause a false to be passed to whenever. (For example, in row 6, d is 0, which means d != 0 will be false.) For those rows, whenever will throw UnmetConditionException, which will cause the forAll method to discard that row.

    condition

    the boolean condition that determines whether whenever will evaluate the fun function (condition is true) or throws UnmetConditionException (<code>condition<code> is false)

    fun

    the function to evaluate if the specified condition is true

    definition classes: Whenever
  61. def workers ( value : Int ) : Workers

    Returns a Workers property check configuration parameter containing the passed value, which specifies the number of worker threads to use when evaluating a property.

    Returns a Workers property check configuration parameter containing the passed value, which specifies the number of worker threads to use when evaluating a property.

    definition classes: Configuration

Inherited from Configuration

Inherited from Whenever

Inherited from AnyRef

Inherited from Any