org.scalacheck

Prop

object Prop

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Prop
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Args = List[Arg[Any]]

  2. sealed case class Exception(e: Throwable) extends Status with Product with Serializable

    Evaluating the property raised an exception

  3. class ExtendedAny[T] extends AnyRef

    A collection of property operators on Any values.

  4. class ExtendedBoolean extends AnyRef

    A collection of property operators on Boolean values.

  5. type FM = FreqMap[Set[Any]]

  6. case class Params(genPrms: Gen.Params, freqMap: FM) extends Product with Serializable

    Property parameters

  7. case class Result(status: Status, args: Args, collected: Set[Any], labels: Set[String]) extends Product with Serializable

    The result of evaluating a property

  8. sealed trait Status extends AnyRef

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def =?[T](x: T, y: T)(implicit pp: (T) ⇒ Pretty): Prop

    Create a property that compares to values.

    Create a property that compares to values. If the values aren't equal, the property will fail and report that second value doesn't match the expected (first) value.

  7. def ?=[T](x: T, y: T)(implicit pp: (T) ⇒ Pretty): Prop

    Create a property that compares to values.

    Create a property that compares to values. If the values aren't equal, the property will fail and report that first value doesn't match the expected (second) value.

  8. implicit def AnyOperators[T](x: ⇒ T)(implicit arg0: (T) ⇒ Pretty): ExtendedAny[T]

    Implicit method that makes a number of property operators on values of type Any available in the current scope.

    Implicit method that makes a number of property operators on values of type Any available in the current scope. See Prop.ExtendedAny for documentation on the operators.

  9. implicit def BooleanOperators(b: ⇒ Boolean): ExtendedBoolean

    Implicit method that makes a number of property operators on boolean values available in the current scope.

    Implicit method that makes a number of property operators on boolean values available in the current scope. See Prop.ExtendedBoolean for documentation on the operators.

  10. object False extends Status with Product with Serializable

    The property was false

  11. object Proof extends Status with Product with Serializable

    The property was proved

  12. object Result extends Serializable

  13. object True extends Status with Product with Serializable

    The property was true

  14. object Undecided extends Status with Product with Serializable

    The property could not be falsified or proved

  15. def all(ps: Prop*): Prop

    Combines properties into one, which is true if and only if all the properties are true

  16. def apply(b: Boolean): Prop

  17. def apply(r: Result): Prop

  18. def apply(f: (Params) ⇒ Result): Prop

  19. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  20. def atLeastOne(ps: Prop*): Prop

    Combines properties into one, which is true if at least one of the properties is true

  21. def classify(c: ⇒ Boolean, ifTrue: Any, ifFalse: Any)(prop: Prop): Prop

    Collect data for presentation in test report

  22. def classify(c: ⇒ Boolean, ifTrue: Any)(prop: Prop): Prop

    Collect data for presentation in test report

  23. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. def collect[T](t: T)(prop: Prop): Prop

    Collect data for presentation in test report

  25. def collect[T, P](f: (T) ⇒ P)(implicit arg0: (P) ⇒ Prop): (T) ⇒ Prop

    Collect data for presentation in test report

  26. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  27. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  28. def exception(e: Throwable): Prop

    A property that denotes an exception

  29. lazy val exception: Prop

    A property that denotes an exception

  30. def exists[A, P](g: Gen[A])(f: (A) ⇒ P)(implicit pv: (P) ⇒ Prop, pp: (A) ⇒ Pretty): Prop

    Existential quantifier for an explicit generator.

  31. def exists[A, P](f: (A) ⇒ P)(implicit pv: (P) ⇒ Prop, pp: (A) ⇒ Pretty, aa: Arbitrary[A]): Prop

    Existential quantifier for an explicit generator.

  32. lazy val falsified: Prop

    A property that always is false

  33. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  34. def forAll[A1, A2, A3, A4, A5, A6, A7, A8, P](f: (A1, A2, A3, A4, A5, A6, A7, A8) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) ⇒ Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) ⇒ Pretty, a7: Arbitrary[A7], s7: Shrink[A7], pp7: (A7) ⇒ Pretty, a8: Arbitrary[A8], s8: Shrink[A8], pp8: (A8) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  35. def forAll[A1, A2, A3, A4, A5, A6, A7, P](f: (A1, A2, A3, A4, A5, A6, A7) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) ⇒ Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) ⇒ Pretty, a7: Arbitrary[A7], s7: Shrink[A7], pp7: (A7) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  36. def forAll[A1, A2, A3, A4, A5, A6, P](f: (A1, A2, A3, A4, A5, A6) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) ⇒ Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  37. def forAll[A1, A2, A3, A4, A5, P](f: (A1, A2, A3, A4, A5) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  38. def forAll[A1, A2, A3, A4, P](f: (A1, A2, A3, A4) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  39. def forAll[A1, A2, A3, P](f: (A1, A2, A3) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  40. def forAll[A1, A2, P](f: (A1, A2) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  41. def forAll[A1, P](f: (A1) ⇒ P)(implicit p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty): Prop

    Converts a function into a universally quantified property

  42. def forAll[T1, T2, T3, T4, T5, T6, T7, T8, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5], g6: Gen[T6], g7: Gen[T7], g8: Gen[T8])(f: (T1, T2, T3, T4, T5, T6, T7, T8) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty, s3: Shrink[T3], pp3: (T3) ⇒ Pretty, s4: Shrink[T4], pp4: (T4) ⇒ Pretty, s5: Shrink[T5], pp5: (T5) ⇒ Pretty, s6: Shrink[T6], pp6: (T6) ⇒ Pretty, s7: Shrink[T7], pp7: (T7) ⇒ Pretty, s8: Shrink[T8], pp8: (T8) ⇒ Pretty): Prop

    Universal quantifier for eight explicit generators.

    Universal quantifier for eight explicit generators. Shrinks failed arguments with the default shrink function for the type

  43. def forAll[T1, T2, T3, T4, T5, T6, T7, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5], g6: Gen[T6], g7: Gen[T7])(f: (T1, T2, T3, T4, T5, T6, T7) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty, s3: Shrink[T3], pp3: (T3) ⇒ Pretty, s4: Shrink[T4], pp4: (T4) ⇒ Pretty, s5: Shrink[T5], pp5: (T5) ⇒ Pretty, s6: Shrink[T6], pp6: (T6) ⇒ Pretty, s7: Shrink[T7], pp7: (T7) ⇒ Pretty): Prop

    Universal quantifier for seven explicit generators.

    Universal quantifier for seven explicit generators. Shrinks failed arguments with the default shrink function for the type

  44. def forAll[T1, T2, T3, T4, T5, T6, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5], g6: Gen[T6])(f: (T1, T2, T3, T4, T5, T6) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty, s3: Shrink[T3], pp3: (T3) ⇒ Pretty, s4: Shrink[T4], pp4: (T4) ⇒ Pretty, s5: Shrink[T5], pp5: (T5) ⇒ Pretty, s6: Shrink[T6], pp6: (T6) ⇒ Pretty): Prop

    Universal quantifier for six explicit generators.

    Universal quantifier for six explicit generators. Shrinks failed arguments with the default shrink function for the type

  45. def forAll[T1, T2, T3, T4, T5, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5])(f: (T1, T2, T3, T4, T5) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty, s3: Shrink[T3], pp3: (T3) ⇒ Pretty, s4: Shrink[T4], pp4: (T4) ⇒ Pretty, s5: Shrink[T5], pp5: (T5) ⇒ Pretty): Prop

    Universal quantifier for five explicit generators.

    Universal quantifier for five explicit generators. Shrinks failed arguments with the default shrink function for the type

  46. def forAll[T1, T2, T3, T4, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4])(f: (T1, T2, T3, T4) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty, s3: Shrink[T3], pp3: (T3) ⇒ Pretty, s4: Shrink[T4], pp4: (T4) ⇒ Pretty): Prop

    Universal quantifier for four explicit generators.

    Universal quantifier for four explicit generators. Shrinks failed arguments with the default shrink function for the type

  47. def forAll[T1, T2, T3, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3])(f: (T1, T2, T3) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty, s3: Shrink[T3], pp3: (T3) ⇒ Pretty): Prop

    Universal quantifier for three explicit generators.

    Universal quantifier for three explicit generators. Shrinks failed arguments with the default shrink function for the type

  48. def forAll[T1, T2, P](g1: Gen[T1], g2: Gen[T2])(f: (T1, T2) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty, s2: Shrink[T2], pp2: (T2) ⇒ Pretty): Prop

    Universal quantifier for two explicit generators.

    Universal quantifier for two explicit generators. Shrinks failed arguments with the default shrink function for the type

  49. def forAll[T1, P](g1: Gen[T1])(f: (T1) ⇒ P)(implicit p: (P) ⇒ Prop, s1: Shrink[T1], pp1: (T1) ⇒ Pretty): Prop

    Universal quantifier for an explicit generator.

    Universal quantifier for an explicit generator. Shrinks failed arguments with the default shrink function for the type

  50. def forAllNoShrink[T1, T2, T3, T4, T5, T6, T7, T8, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5], g6: Gen[T6], g7: Gen[T7], g8: Gen[T8])(f: (T1, T2, T3, T4, T5, T6, T7, T8) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty, pp3: (T3) ⇒ Pretty, pp4: (T4) ⇒ Pretty, pp5: (T5) ⇒ Pretty, pp6: (T6) ⇒ Pretty, pp7: (T7) ⇒ Pretty, pp8: (T8) ⇒ Pretty): Prop

    Universal quantifier for eight explicit generators.

    Universal quantifier for eight explicit generators. Does not shrink failed test cases.

  51. def forAllNoShrink[T1, T2, T3, T4, T5, T6, T7, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5], g6: Gen[T6], g7: Gen[T7])(f: (T1, T2, T3, T4, T5, T6, T7) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty, pp3: (T3) ⇒ Pretty, pp4: (T4) ⇒ Pretty, pp5: (T5) ⇒ Pretty, pp6: (T6) ⇒ Pretty, pp7: (T7) ⇒ Pretty): Prop

    Universal quantifier for seven explicit generators.

    Universal quantifier for seven explicit generators. Does not shrink failed test cases.

  52. def forAllNoShrink[T1, T2, T3, T4, T5, T6, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5], g6: Gen[T6])(f: (T1, T2, T3, T4, T5, T6) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty, pp3: (T3) ⇒ Pretty, pp4: (T4) ⇒ Pretty, pp5: (T5) ⇒ Pretty, pp6: (T6) ⇒ Pretty): Prop

    Universal quantifier for six explicit generators.

    Universal quantifier for six explicit generators. Does not shrink failed test cases.

  53. def forAllNoShrink[T1, T2, T3, T4, T5, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4], g5: Gen[T5])(f: (T1, T2, T3, T4, T5) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty, pp3: (T3) ⇒ Pretty, pp4: (T4) ⇒ Pretty, pp5: (T5) ⇒ Pretty): Prop

    Universal quantifier for five explicit generators.

    Universal quantifier for five explicit generators. Does not shrink failed test cases.

  54. def forAllNoShrink[T1, T2, T3, T4, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3], g4: Gen[T4])(f: (T1, T2, T3, T4) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty, pp3: (T3) ⇒ Pretty, pp4: (T4) ⇒ Pretty): Prop

    Universal quantifier for four explicit generators.

    Universal quantifier for four explicit generators. Does not shrink failed test cases.

  55. def forAllNoShrink[T1, T2, T3, P](g1: Gen[T1], g2: Gen[T2], g3: Gen[T3])(f: (T1, T2, T3) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty, pp3: (T3) ⇒ Pretty): Prop

    Universal quantifier for three explicit generators.

    Universal quantifier for three explicit generators. Does not shrink failed test cases.

  56. def forAllNoShrink[T1, T2, P](g1: Gen[T1], g2: Gen[T2])(f: (T1, T2) ⇒ P)(implicit p: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty, pp2: (T2) ⇒ Pretty): Prop

    Universal quantifier for two explicit generators.

    Universal quantifier for two explicit generators. Does not shrink failed test cases.

  57. def forAllNoShrink[T1, P](g1: Gen[T1])(f: (T1) ⇒ P)(implicit pv: (P) ⇒ Prop, pp1: (T1) ⇒ Pretty): Prop

    Universal quantifier for an explicit generator.

    Universal quantifier for an explicit generator. Does not shrink failed test cases.

  58. def forAllShrink[T, P](g: Gen[T], shrink: (T) ⇒ Stream[T])(f: (T) ⇒ P)(implicit arg0: (T) ⇒ Pretty, arg1: (P) ⇒ Prop): Prop

    Universal quantifier for an explicit generator.

    Universal quantifier for an explicit generator. Shrinks failed arguments with the given shrink function

  59. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  60. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  61. def iff[T](x: T, f: PartialFunction[T, Prop]): Prop

    Property holds only if the given partial function is defined at x, and returns a property that holds

  62. def imply[T](x: T, f: PartialFunction[T, Prop]): Prop

    Implication with several conditions

  63. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  64. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  65. def noneFailing[T](gs: Seq[Gen[T]]): Prop

    A property that holds iff none of the given generators fails generating a value

  66. final def notify(): Unit

    Definition Classes
    AnyRef

  67. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  68. lazy val passed: Prop

    A property that always is passed

  69. implicit def propBoolean(b: Boolean): Prop

    Implicit conversion of Boolean values to Prop values.

  70. lazy val proved: Prop

    A property that always is proved

  71. def secure[P](p: ⇒ P)(implicit arg0: (P) ⇒ Prop): Prop

    Wraps and protects a property

  72. def sizedProp(f: (Int) ⇒ Prop): Prop

    A property that depends on the generator size

  73. def someFailing[T](gs: Seq[Gen[T]]): Prop

    A property that holds if at least one of the given generators fails generating a value

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

    Definition Classes
    AnyRef

  75. def throws[T <: Throwable](c: Class[T])(x: ⇒ Any): Boolean

    Returns true if the given statement throws an exception of the specified type

  76. def toString(): String

    Definition Classes
    AnyRef → Any

  77. lazy val undecided: Prop

    A property that never is proved or falsified

  78. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  80. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  81. def within(maximumMs: Long)(wrappedProp: ⇒ Prop): Prop

    Ensures that the property expression passed in completes within the given space of time.

Deprecated Value Members

  1. implicit def extendedAny[T](x: ⇒ T)(implicit arg0: (T) ⇒ Pretty): ExtendedAny[T]

    Implicit method that makes a number of property operators on values of type Any available in the current scope.

    Implicit method that makes a number of property operators on values of type Any available in the current scope. See Prop.ExtendedAny for documentation on the operators.

    Annotations
    @deprecated
    Deprecated

    (Since version 1.10.1) Use 'Prop.AnyOperators' instead

  2. def throws[T <: Throwable](x: ⇒ Any, c: Class[T]): Prop

    A property that holds if the given statement throws an exception of the specified type

    A property that holds if the given statement throws an exception of the specified type

    Annotations
    @deprecated
    Deprecated

    (Since version 1.10.1) Use 'throws(...): Boolean' instead

Inherited from AnyRef

Inherited from Any

Ungrouped