Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalatest

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    org
  • package prop

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    scalatest
  • 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).

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

    Definition Classes
    prop
  • MaxDiscarded
  • MaxDiscardedFactor
  • MaxSize
  • MinSize
  • MinSuccessful
  • PropertyCheckConfig
  • PropertyCheckConfigParam
  • PropertyCheckConfigurable
  • PropertyCheckConfiguration
  • SizeRange
  • Workers
ScalaTest is brought to you by:
c

org.scalatest.prop.Configuration

PropertyCheckConfig

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.

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

Source
Configuration.scala
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.

Linear Supertypes
Serializable, Serializable, Product, Equals, PropertyCheckConfigurable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PropertyCheckConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PropertyCheckConfigurable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PropertyCheckConfig(minSuccessful: Int = 10, maxDiscarded: Int = 500, minSize: Int = 0, maxSize: Int = 100, workers: Int = 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.

Value Members

  1. val maxDiscarded: Int
  2. val maxSize: Int
  3. val minSize: Int
  4. val minSuccessful: Int
  5. val workers: Int