Class/Object

org.typelevel.claimant

Claim

Related Docs: object Claim | package claimant

Permalink

sealed abstract class Claim extends AnyRef

Claim represents a Boolean result with a description of what that result means.

Claims can be composed using the same operators as Booleans, which correspond to recursive Claim subtypes (e.g. And, Or, etc.).

All claims can be converted into ScalaCheck Prop values. (The reverse is not true -- it's not possible to extra ScalaCheck labels from a Prop without running it.)

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Claim
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &(that: Claim): Claim

    Permalink

    Combine two claims, requiring both to be true.

    Combine two claims, requiring both to be true.

    This is equivalent to & and && for Boolean. It is not named && because it does not short-circuit evaluation -- the right-hand side will be evaluated even if the left-hand side is false.

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

    Permalink
    Definition Classes
    AnyRef → Any
  5. def ^(that: Claim): Claim

    Permalink

    Combine two claims, requiring exactly one to be true.

    Combine two claims, requiring exactly one to be true.

    This is eqvuialent to ^ for Boolean. It is an exclusive-or, which means that it is false if both claims are false or both claims are true, and true otherwise.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  14. def label: String

    Permalink

    Label explaining a claim's expression.

    Label explaining a claim's expression.

    This label will be used with ScalaCheck to explain failing properties. Crucially, it will be called recursively, so it should not add information that is only relevant at the top-level.

    The convention is _not_ to parenthesize a top-level expression in a label, but only sub-expressions.

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

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def prop: Prop

    Permalink

    Build a ScalaCheck Prop value from a claim.

    Build a ScalaCheck Prop value from a claim.

    This Prop uses two values from the claim: the res and the label. Currently it only attaches a label to failed Prop values, although this could change in the future.

  19. val res: Boolean

    Permalink
  20. def status: String

    Permalink

    Display a status string for a claim.

    Display a status string for a claim.

    This method is used to annotate sub-claims in a larger claim.

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

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. def unary_!: Claim

    Permalink

    Negate this claim, requiring it to be false.

  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def |(that: Claim): Claim

    Permalink

    Combine two claims, requiring at least one to be true.

    Combine two claims, requiring at least one to be true.

    This is equivalent to | and || for Boolean. It is not named || because it does not short-circuit evaluation -- the right-hand side will be evaluated even if the left-hand side is true.

Inherited from AnyRef

Inherited from Any

Ungrouped