org.scalacheck

Properties

class Properties extends Prop

Represents a collection of properties, with convenient methods for checking all properties at once. This class is itself a property, which holds if and only if all of the contained properties hold.

Properties are added in the following way:

object MyProps extends Properties("MyProps") { property("myProp1") = forAll { (n:Int, m:Int) => n+m == m+n }

property("myProp2") = ((0/1) throws classOf[ArithmeticException]) }

Inherited
  1. Hide All
  2. Show all
  1. Prop
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new Properties(name: String)

Type Members

  1. class PropertySpecifier extends AnyRef

    Used for specifying properties.

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def &&(p: Prop): Prop

    Returns a new property that holds if and only if both this and the given property hold.

    Returns a new property that holds if and only if both this and the given property hold. If one of the properties doesn't generate a result, the new property will generate false.

    definition classes: Prop
  7. def ++(p: Prop): Prop

    Returns a new property that holds if and only if both this and the given property hold.

    Returns a new property that holds if and only if both this and the given property hold. If one of the properties doesn't generate a result, the new property will generate the same result as the other property.

    definition classes: Prop
  8. def :|(l: Symbol): Prop

    Put a label on the property to make test reports clearer

    Put a label on the property to make test reports clearer

    definition classes: Prop
  9. def :|(l: String): Prop

    Put a label on the property to make test reports clearer

    Put a label on the property to make test reports clearer

    definition classes: Prop
  10. def ==(p: Prop): Prop

    Returns a new property that holds if and only if both this and the given property generates a result with the exact same status.

    Returns a new property that holds if and only if both this and the given property generates a result with the exact same status. Note that this means that if one of the properties is proved, and the other one passed, then the resulting property will fail.

    definition classes: Prop
  11. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  12. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  13. def ===(p: Prop): Prop

    Returns a new property that holds if and only if both this and the given property generates a result with the exact same status.

    Returns a new property that holds if and only if both this and the given property generates a result with the exact same status. Note that this means that if one of the properties is proved, and the other one passed, then the resulting property will fail.

    definition classes: Prop
      deprecated:
    1. Use == instead.

  14. def ==>(p: ⇒ Prop): Prop

    Combines two properties through implication

    Combines two properties through implication

    definition classes: Prop
  15. def apply(p: Params): Result

    definition classes: PropertiesProp
  16. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  17. def check: Unit

    Convenience method that checks all properties and reports the result on the console.

    Convenience method that checks all properties and reports the result on the console. Calling ps.check is equal to calling Test.checkProperties(ps), but this method does not return the test statistics. If you need to get the results from the tests, or if you want more control over the test parameters, use the checkProperties methods in Test instead.

    definition classes: PropertiesProp
  18. def check(prms: Params): Unit

    definition classes: PropertiesProp
  19. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  20. def combine(p: Prop)(f: (Result, Result) ⇒ Result): Prop

    definition classes: Prop
  21. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  22. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  23. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  24. def flatMap(f: (Result) ⇒ Prop): Prop

    definition classes: Prop
  25. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  26. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  27. def include(ps: Properties): Unit

    Adds all properties from another property collection to this one.

    Adds all properties from another property collection to this one.

  28. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  29. def label(l: String): Prop

    Put a label on the property to make test reports clearer

    Put a label on the property to make test reports clearer

    definition classes: Prop
  30. def main(args: Array[String]): Unit

    Convenience method that makes it possible to use a this property as an application that checks itself on execution

    Convenience method that makes it possible to use a this property as an application that checks itself on execution

    definition classes: Prop
  31. def map(f: (Result) ⇒ Result): Prop

    definition classes: Prop
  32. val name: String

  33. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  34. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  35. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  36. def properties: Seq[(String, Prop)]

    Returns all properties of this collection in a list of name/property pairs.

    Returns all properties of this collection in a list of name/property pairs.

  37. lazy val property: PropertySpecifier

  38. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  39. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: Prop → AnyRef → Any
  40. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  41. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  42. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  43. def |:(l: Symbol): Prop

    Put a label on the property to make test reports clearer

    Put a label on the property to make test reports clearer

    definition classes: Prop
  44. def |:(l: String): Prop

    Put a label on the property to make test reports clearer

    Put a label on the property to make test reports clearer

    definition classes: Prop
  45. def ||(p: Prop): Prop

    Returns a new property that holds if either this or the given property (or both) hold.

    Returns a new property that holds if either this or the given property (or both) hold.

    definition classes: Prop