org.specs2.form.Prop

The Prop class is a named property which holds:

an expected value
an actual value
a constraint to check if the actual value conforms to the expected one

This property can be executed and can be inserted in a Form.

A Prop is meant to be declared as "bound" to an actual value:

val customerName = Prop("Customer name", person.name)

[the actual value is not evaluated until the Prop is executed]

Then it can be associated an expected value with the apply method (usually in a Form declaration):

customerName("Bill")

The actual and the expected values can have different types and the constraint which is applied to them can be anything returning a result.

However the Prop companion object provides a method to create a Property with a constraint using a beEqualTo matcher:

Prop("Name", "Eric")("Eric") must_== Success("'Eric' is equal to 'Eric'")

Linear Supertypes

Serializable, Serializable, Product, Equals, DecoratedProperty[Prop[T, S]], DecoratedLabel[Prop[T, S]], Executable, AnyRef, Any

Instance Constructors

new Prop(label: String = "", actual: Property[T] = control.Property.apply[T](), expected: Property[S] = control.Property.apply[S](), constraint: (T, S) ⇒ Result = Prop.checkProp[Any, Nothing], decorator: Decorator = ...)

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
val actual: Property[T]
lazy val actualValue: Product with Serializable with Either[Result, T]

returns
the actual value as either Right(value) or Left(result)
def apply(e: ⇒ S): Prop[T, S]

The apply method sets the expected value and returns the Prop
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canEqual(arg0: Any): Boolean

Definition Classes
Prop → Equals
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
val constraint: (T, S) ⇒ Result
def decorateLabel(ns: Any): Any

do the decoration
do the decoration

Definition Classes
DecoratedLabel
def decorateLabelWith(f: (Any) ⇒ Any): Prop[T, S]

set a new Decorator for the label
set a new Decorator for the label

Definition Classes
DecoratedLabel
def decorateValue(ns: Any): Any

do the decoration
do the decoration

Definition Classes
DecoratedProperty
def decorateValueWith(f: (Any) ⇒ Any): Prop[T, S]

set a new Decorator for the value
set a new Decorator for the value

Definition Classes
DecoratedProperty
def decorateWith(f: (Any) ⇒ Any): Prop[T, S]

set a new Decorator
set a new Decorator

Definition Classes
DecoratedProperty
val decorator: Decorator

Definition Classes
Prop → DecoratedLabel
def decoratorIs(d: Decorator): Prop[T, S]

set a new Decorator
set a new Decorator

Definition Classes
Prop → DecoratedLabel
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(a: Any): Boolean

Definition Classes
Prop → Equals → AnyRef → Any
def execute: Result

execute the constraint set on this property, with the expected value
execute the constraint set on this property, with the expected value
returns
a Result

Definition Classes
Prop → Executable
val expected: Property[S]
lazy val expectedValue: Product with Serializable with Either[Result, S]

returns
the expected value as an option
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def get: S

shortcut method for this().
shortcut method for this().get returning the contained expected value.
returns
the expected value if set and throws an exception otherwise
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
val label: String
def labelStyles: String

return the label styles
return the label styles

Definition Classes
DecoratedLabel
def map(f: (Result) ⇒ Result): Executable

modify the result to return
modify the result to return

Definition Classes
Executable
def matchWith(c: (T, S) ⇒ Result): Prop[T, S]

set a specific constraint on the property
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def productArity: Int

Definition Classes
Prop → Product
def productElement(arg0: Int): Any

Definition Classes
Prop → Product
def productIterator: Iterator[Any]

Definition Classes
Product
def productPrefix: String

Definition Classes
Prop → Product
def resultIs(r: ⇒ Result): Prop[T, S]

set a specific result on the property
def styleLabelWith(s: (String, String)): Prop[T, S]

set a new style for the label
set a new style for the label

Definition Classes
DecoratedLabel
def styleValueWith(s: (String, String)): Prop[T, S]

set a new style for the value
set a new style for the value

Definition Classes
DecoratedProperty
def styleWith(s: (String, String)): Prop[T, S]

set a new style
set a new style

Definition Classes
DecoratedProperty
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Display the property:
Display the property:
label: "this" (actual: "that")

Definition Classes
Prop → AnyRef → Any
def valueStyles: String

Definition Classes
DecoratedProperty
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws()

Deprecated Value Members

def productElements: Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
(Since version 2.8.0) use productIterator instead

Prop

case class Prop[T, S](label: String, actual: Property[T], expected: Property[S], constraint: (T, S) ⇒ Result, decorator: Decorator) extends Executable with DecoratedProperty[Prop[T, S]] with Product with Serializable

Instance Constructors

new Prop(label: String = "", actual: Property[T] = control.Property.apply[T](), expected: Property[S] = control.Property.apply[S](), constraint: (T, S) ⇒ Result = Prop.checkProp[Any, Nothing], decorator: Decorator = ...)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val actual: Property[T]

lazy val actualValue: Product with Serializable with Either[Result, T]

def apply(e: ⇒ S): Prop[T, S]

final def asInstanceOf[T0]: T0

def canEqual(arg0: Any): Boolean

def clone(): AnyRef

val constraint: (T, S) ⇒ Result

def decorateLabel(ns: Any): Any

def decorateLabelWith(f: (Any) ⇒ Any): Prop[T, S]

def decorateValue(ns: Any): Any

def decorateValueWith(f: (Any) ⇒ Any): Prop[T, S]

def decorateWith(f: (Any) ⇒ Any): Prop[T, S]

val decorator: Decorator

def decoratorIs(d: Decorator): Prop[T, S]

final def eq(arg0: AnyRef): Boolean

def equals(a: Any): Boolean

def execute: Result

val expected: Property[S]

lazy val expectedValue: Product with Serializable with Either[Result, S]

def finalize(): Unit

def get: S

final def getClass(): java.lang.Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val label: String

def labelStyles: String

def map(f: (Result) ⇒ Result): Executable

def matchWith(c: (T, S) ⇒ Result): Prop[T, S]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def productArity: Int

def productElement(arg0: Int): Any

def productIterator: Iterator[Any]

def productPrefix: String

def resultIs(r: ⇒ Result): Prop[T, S]

def styleLabelWith(s: (String, String)): Prop[T, S]

def styleValueWith(s: (String, String)): Prop[T, S]

def styleWith(s: (String, String)): Prop[T, S]

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

def toString(): String

def valueStyles: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def productElements: Iterator[Any]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DecoratedProperty[Prop[T, S]]

Inherited from DecoratedLabel[Prop[T, S]]

Inherited from Executable

Inherited from AnyRef

Inherited from Any