Configuration

Type Members

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.
Exceptions thrown
IllegalArgumentException
if specified value is less than zero.
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.

Exceptions thrown
IllegalArgumentException
if specified value is less than zero.
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).
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).

Exceptions thrown
IllegalArgumentException
if specified value is less than zero.
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.
A PropertyCheckConfigParam that specifies the minimum number of successful property evaluations required for the property to pass.

Exceptions thrown
IllegalArgumentException
if specified value is less than or equal to zero.
case class PropertyCheckConfig(minSuccessful: Int = 100, maxDiscarded: Int = 500, minSize: Int = 0, maxSize: Int = 100, workers: Int = 1) extends 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

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.
sealed abstract class PropertyCheckConfigParam extends AnyRef

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).
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.
A PropertyCheckConfigParam that specifies the number of worker threads to use when evaluating a property.

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

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
implicit val generatorDrivenConfig: PropertyCheckConfig

Implicit PropertyCheckConfig value providing default configuration values.
Implicit PropertyCheckConfig value providing default configuration values.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
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.

Exceptions thrown
IllegalArgumentException
if specified value is less than zero.
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.

Exceptions thrown
IllegalArgumentException
if specified value is less than zero.
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).

Exceptions thrown
IllegalArgumentException
if specified value is less than zero.
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.

Exceptions thrown
IllegalArgumentException
if specified value is less than or equal to zero.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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.

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

trait Configuration extends AnyRef

Type Members

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

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

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

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

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

sealed abstract class PropertyCheckConfigParam extends AnyRef

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

implicit val generatorDrivenConfig: PropertyCheckConfig

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def maxDiscarded(value: Int): MaxDiscarded

def maxSize(value: Int): MaxSize

def minSize(value: Int): MinSize

def minSuccessful(value: Int): MinSuccessful

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def workers(value: Int): Workers

Inherited from AnyRef

Inherited from Any

Ungrouped

minSuccessful	100
maxDiscarded	500
minSize	0
maxSize	100
workers	1