specs2-form
API
Generated with
specs2-form/org.specs2/org.specs2.form/Prop

Prop

org.specs2.form.Prop
See theProp companion object
case class Prop[T, S](label: String, actual: Property[T], expected: Property[S], constraint: (T, S) => Result, decorator: Decorator) extends Executable, DecoratedProperty[Prop[T, S]]

The Prop class is a named property which holds:

  • an actual value
  • an expected 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'")

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait DecoratedProperty[Prop[T, S]]
trait DecoratedLabel[Prop[T, S]]
trait Executable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

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

The apply method sets the expected value and returns the Prop

The apply method sets the expected value and returns the Prop

Attributes

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

set a new Decorator

set a new Decorator

Attributes

override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an 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 Any 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 usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

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

Definition Classes
Equals -> 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

Attributes

override def hashCode: Int

Calculate a hash code value for the object.

Calculate 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.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def matchWith(c: (T, S) => Result): Prop[T, S]

set a specific constraint between the actual and expected value

set a specific constraint between the actual and expected value

Attributes

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

set a specific result on the property

set a specific result on the property

Attributes

override def toString: String

Display the property:

Display the property:

label: "this" (actual: "that")

Attributes

Definition Classes
Any

Inherited methods

def decorateLabel(ns: Any): Any

do the decoration

do the decoration

Attributes

Inherited from:
DecoratedLabel
def decorateLabelWith(f: Any => Any): T

set a new Decorator for the label

set a new Decorator for the label

Attributes

Inherited from:
DecoratedLabel
def decorateValue(ns: Any): Any

do the decoration

do the decoration

Attributes

Inherited from:
DecoratedProperty
def decorateValueWith(f: Any => Any): T

set a new Decorator for the value

set a new Decorator for the value

Attributes

Inherited from:
DecoratedProperty
def decorateWith(f: Any => Any): T

set a new Decorator

set a new Decorator

Attributes

Inherited from:
DecoratedProperty
def labelStyles: String

return the label styles

return the label styles

Attributes

Inherited from:
DecoratedLabel
def map(f: Result => Result): Executable

modify the result to return

modify the result to return

Attributes

Inherited from:
Executable
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def styleLabelWith(s: (String, String)): T

set a new style for the label

set a new style for the label

Attributes

Inherited from:
DecoratedLabel
def styleValueWith(s: (String, String)): T

set a new style for the value

set a new style for the value

Attributes

Inherited from:
DecoratedProperty
def styleWith(s: (String, String)): T

set a new style

set a new style

Attributes

Inherited from:
DecoratedProperty
def valueStyles: String

Attributes

Inherited from:
DecoratedProperty

Concrete fields

lazy val actualValue: Either[Result, T]

Attributes

Returns

the actual value as either Right(value) or Left(result)

lazy val expectedValue: Either[Result, S]

Attributes

Returns

the expected value as an option

Generated with