org.scalacheck

Gen

Related Docs: object Gen | package scalacheck

sealed abstract class Gen[+T] extends Serializable

Self Type
Gen[T]
Source
Gen.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Gen
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class RetryUntilException(n: Int) extends RuntimeException with Product with Serializable

  2. final class WithFilter extends AnyRef

    A class supporting filtered operations.

Value Members

  1. def !=[U](g: Gen[U]): Prop

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

    Definition Classes
    AnyRef → Any
  3. def !==[U](g: Gen[U]): Prop

  4. final def ##(): Int

    Definition Classes
    AnyRef → Any
  5. def :|(l: Symbol): Gen[T]

    Put a label on the generator to make test reports clearer

  6. def :|(l: String): Gen[T]

    Put a label on the generator to make test reports clearer

  7. def ==[U](g: Gen[U]): Prop

    Returns a new property that holds if and only if both this and the given generator generates the same result, or both generators generate no result.

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

    Definition Classes
    AnyRef → Any
  9. def apply(p: Parameters, seed: Seed): Option[T]

    Evaluate this generator with the given parameters

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def doPureApply(p: Parameters, seed: Seed, retries: Int = 100): R[T]

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

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def filter(p: (T) ⇒ Boolean): Gen[T]

    Create a new generator that uses this generator to produce a value that fulfills the given condition.

    Create a new generator that uses this generator to produce a value that fulfills the given condition. If the condition is not fulfilled, the generator fails (returns None). Also, make sure that the provided test property is side-effect free, eg it should not use external vars.

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def flatMap[U](f: (T) ⇒ Gen[U]): Gen[U]

    Create a new generator by flat-mapping the result of this generator

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

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def label(l: String): Gen[T]

    Put a label on the generator to make test reports clearer

  22. def map[U](f: (T) ⇒ U): Gen[U]

    Create a new generator by mapping the result of this generator

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

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. def pureApply(p: Parameters, seed: Seed, retries: Int = 100): T

    Evaluate this generator with the given parameters.

    Evaluate this generator with the given parameters.

    The generator will attempt to generate a valid T value. If a valid value is not produced it may retry several times, determined by the retries parameter (which defaults to 100).

    If all the retries fail it will throw a Gen.RetrievalError exception.

  27. def retryUntil(p: (T) ⇒ Boolean): Gen[T]

    Create a generator that calls this generator repeatedly until the given condition is fulfilled.

    Create a generator that calls this generator repeatedly until the given condition is fulfilled. The generated value is then returned. Make sure that the provided test property is side-effect free (it should not use external vars).

    If the generator fails more than 10000 times, a RetryUntilException will be thrown. You can call retryUntil with a second parameter to change this number.

  28. def retryUntil(p: (T) ⇒ Boolean, maxTries: Int): Gen[T]

    Create a generator that calls this generator repeatedly until the given condition is fulfilled.

    Create a generator that calls this generator repeatedly until the given condition is fulfilled. The generated value is then returned. Make sure that the provided test property is side-effect free (it should not use external vars).

    If the generator fails more than maxTries, a RetryUntilException will be thrown.

  29. def sample: Option[T]

  30. def suchThat(f: (T) ⇒ Boolean): Gen[T]

    Create a new generator that uses this generator to produce a value that fulfills the given condition.

    Create a new generator that uses this generator to produce a value that fulfills the given condition. If the condition is not fulfilled, the generator fails (returns None). Also, make sure that the provided test property is side-effect free, eg it should not use external vars. This method is identical to [Gen.filter].

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

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def withFilter(p: (T) ⇒ Boolean): WithFilter

    Creates a non-strict filtered version of this generator.

  37. def withPerturb(f: (Seed) ⇒ Seed): Gen[T]

    Perform some RNG perturbation before generating

  38. def |:(l: Symbol): Gen[T]

    Put a label on the generator to make test reports clearer

  39. def |:(l: String): Gen[T]

    Put a label on the generator to make test reports clearer

Deprecated Value Members

  1. def collect[U](pf: PartialFunction[T, U]): Gen[U]

    Create a new generator that fails if the specified partial function is undefined for this generator's value, otherwise returns the result of the partial function applied to this generator's value.

    Create a new generator that fails if the specified partial function is undefined for this generator's value, otherwise returns the result of the partial function applied to this generator's value.

    Annotations
    @deprecated
    Deprecated

    (Since version 1.14.0) Empty generators are discouraged.

  2. def flatten[U](implicit asOption: (T) ⇒ Option[U]): Gen[U]

    Annotations
    @deprecated
    Deprecated

    (Since version 1.14.0) Empty generators are discouraged.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped