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.
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 inGeneratorDrivenPropertyChecks
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 inCheckers
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
- Source
- Configuration.scala
- Exceptions thrown
IllegalArgumentException
if specifiedvalue
is less than zero.
- Alphabetic
- By Inheritance
- MaxDiscarded
- PropertyCheckConfigParam
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MaxDiscarded(value: Int)
- Exceptions thrown
IllegalArgumentException
if specifiedvalue
is less than 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val value: Int
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()