Type Members

1.  case class MaxDiscardedFactor(value: PosZDouble) extends PropertyCheckConfigParam with Product with Serializable

   Definition Classes

   Configuration

2.  case class MinSize(value: PosZInt) 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).

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

   Definition Classes

   Configuration

   Exceptions thrown

   IllegalArgumentException if specified value is less than zero.

3.  case class MinSuccessful(value: PosInt) extends PropertyCheckConfigParam with Product with Serializable

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

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

   Definition Classes

   Configuration

4.  sealed abstract class PropertyCheckConfigParam extends Product with Serializable

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

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

   The subclasses of this abstract class are used to pass configuration information to the forAll methods of traits PropertyChecks (for ScalaTest-style property checks) and Checkers(for ScalaCheck-style property checks).

   Definition Classes

   Configuration

5.  case class PropertyCheckConfiguration(minSuccessful: PosInt = PosInt(10), maxDiscardedFactor: PosZDouble = PosZDouble(5.0), minSize: PosZInt = PosZInt(0), sizeRange: PosZInt = PosZInt(100), workers: PosInt = PosInt(1)) extends PropertyCheckConfigurable with Product with Serializable

   Definition Classes

   Configuration

6.  case class SizeRange(value: PosZInt) extends PropertyCheckConfigParam with Product with Serializable

   A PropertyCheckConfigParam that (with minSize) 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).

   A PropertyCheckConfigParam that (with minSize) 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 size range is added to minSize in order to calculate the maximum size passed to ScalaCheck. Using a range allows compile-time checking of a non-negative number being specified.

   Definition Classes

   Configuration

7.  case class Workers(value: PosInt) extends PropertyCheckConfigParam with Product with Serializable

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

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

   Definition Classes

   Configuration

   Exceptions thrown

   IllegalArgumentException if specified value is less than or equal to zero.

8.  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.

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

   In GeneratorDrivenPropertyChecks, a property evaluation is discarded if it throws DiscardedEvaluationException, which is produce by whenever clause that evaluates to false. For example, consider this ScalaTest property check:

   // forAll defined in GeneratorDrivenPropertyChecks
   forAll { (n: Int) =>
     whenever (n > 0) {
       doubleIt(n) should equal (n * 2)
     }
   }
   
   
   

   In the above code, whenever a non-positive n is passed, the property function will complete abruptly with DiscardedEvaluationException.

   Similarly, in Checkers, a property evaluation is discarded if the expression to the left of ScalaCheck's ==> operator is false. Here's an example:

   // forAll defined in Checkers
   forAll { (n: Int) =>
     (n > 0) ==> doubleIt(n) == (n * 2)
   }
   
   
   

   For either kind of property check, MaxDiscarded indicates the maximum number of discarded evaluations that will be allowed. As soon as one past this number of evaluations indicates it needs to be discarded, the property check will fail.

   Definition Classes

   Configuration

   Annotations

   @deprecated

   Deprecated

   Exceptions thrown

   IllegalArgumentException if specified value is less than zero.

9.  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).

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

   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

   Annotations

   @deprecated

   Deprecated

   use SizeRange instead

   Exceptions thrown

   IllegalArgumentException if specified value is less than zero.

10.  case class PropertyCheckConfig(minSuccessful: Int = 10, maxDiscarded: Int = 500, minSize: Int = 0, maxSize: Int = 100, workers: Int = 1) extends PropertyCheckConfigurable with Product with Serializable

    Configuration object for property checks.

    Configuration object for property checks.

    The default values for the parameters are:

    minSuccessful	100
    maxDiscarded	500
    minSize	0
    maxSize	100
    workers	1

    minSuccessful

    the minimum number of successful property evaluations required for the property to pass.

    maxDiscarded

    the maximum number of discarded property evaluations allowed during a property check

    minSize

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

    maxSize

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

    workers

    specifies the number of worker threads to use during property evaluation

    Definition Classes

    Configuration

    Annotations

    @deprecated

    Deprecated

    Use PropertyCheckConfiguration instead

    Exceptions thrown

    IllegalArgumentException if the specified minSuccessful value is less than or equal to zero, the specified maxDiscarded value is less than zero, the specified minSize value is less than zero, the specified maxSize value is less than zero, the specified minSize is greater than the specified or default value of maxSize, or the specified workers value is less than or equal to zero.

11.  trait PropertyCheckConfigurable extends AnyRef

    Definition Classes

    Configuration

    Annotations

    @deprecated

    Deprecated

    Use PropertyCheckConfiguration directly instead.