trait Configuration extends AnyRef
Trait providing methods and classes used to configure property checks provided by the
the forAll
methods of trait GeneratorDrivenPropertyChecks
(for ScalaTest-style
property checks) and the check
methods of trait Checkers
(for ScalaCheck-style property checks).
- Source
- Configuration.scala
- Alphabetic
- By Inheritance
- Configuration
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- case class MaxDiscardedFactor (value: PosZDouble) extends PropertyCheckConfigParam with Product with Serializable
-
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).- Exceptions thrown
IllegalArgumentException
if specifiedvalue
is less than zero.
-
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. -
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 traitsPropertyChecks
(for ScalaTest-style property checks) andCheckers
(for ScalaCheck-style property checks). - 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
-
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.
-
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.- Exceptions thrown
IllegalArgumentException
if specifiedvalue
is less than or equal to zero.
-
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 throwsDiscardedEvaluationException
, which is produce bywhenever
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 withDiscardedEvaluationException
.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.- Annotations
- @deprecated
- Deprecated
- Exceptions thrown
IllegalArgumentException
if specifiedvalue
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 theforAll
methods of traitsPropertyChecks
andCheckers
. In other words, it is enforced at the point both a maximum and minimum size are provided together.- Annotations
- @deprecated
- Deprecated
use SizeRange instead
- Exceptions thrown
IllegalArgumentException
if specifiedvalue
is less than zero.
-
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
- Annotations
- @deprecated
- Deprecated
Use PropertyCheckConfiguration instead
- Exceptions thrown
IllegalArgumentException
if the specifiedminSuccessful
value is less than or equal to zero, the specifiedmaxDiscarded
value is less than zero, the specifiedminSize
value is less than zero, the specifiedmaxSize
value is less than zero, the specifiedminSize
is greater than the specified or default value ofmaxSize
, or the specifiedworkers
value is less than or equal to zero.
-
trait
PropertyCheckConfigurable
extends AnyRef
- Annotations
- @deprecated
- Deprecated
Use PropertyCheckConfiguration directly instead.
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
-
implicit
def
PropertyCheckConfig2PropertyCheckConfiguration(p: PropertyCheckConfig): PropertyCheckConfiguration
Implicitly converts
PropertyCheckConfig
s toPropertyCheckConfiguration
, which enables a smoother upgrade path.Implicitly converts
PropertyCheckConfig
s toPropertyCheckConfiguration
, which enables a smoother upgrade path. -
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: PropertyCheckConfiguration
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
maxDiscardedFactor(value: PosZDouble): MaxDiscardedFactor
Returns a
MaxDiscardedFactor
property check configuration parameter containing the passed value, which specifies the factor of discarded property evaluations allowed during property evaluation.Returns a
MaxDiscardedFactor
property check configuration parameter containing the passed value, which specifies the factor of discarded property evaluations allowed during property evaluation. -
def
minSize(value: PosZInt): 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). -
def
minSuccessful(value: PosInt): 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. -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
sizeRange(value: PosZInt): SizeRange
Returns a
SizeRange
property check configuration parameter containing the passed value, 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).Returns a
SizeRange
property check configuration parameter containing the passed value, 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.
-
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: PosInt): 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. - object PropertyCheckConfiguration extends Serializable
Deprecated Value Members
-
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.- Annotations
- @deprecated
- Deprecated
use maxDiscardedFactor instead
- Exceptions thrown
IllegalArgumentException
if specifiedvalue
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 theforAll
methods of traitsPropertyChecks
andCheckers
. In other words, it is enforced at the point both a maximum and minimum size are provided together.- Annotations
- @deprecated
- Deprecated
use SizeRange instead
- Exceptions thrown
IllegalArgumentException
if specifiedvalue
is less than zero.