WrappedMapping

play.api.data.WrappedMapping
case class WrappedMapping[A, B](wrapped: Mapping[A], f1: A => B, f2: B => A, additionalConstraints: Seq[Constraint[B]]) extends Mapping[B]

A mapping wrapping another existing mapping with transformation functions.

Value parameters

additionalConstraints

Additional constraints of type B

f1

Transformation function from A to B

f2

Transformation function from B to A

wrapped

Existing wrapped mapping

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Mapping[B]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def bind(data: Map[String, String]): Either[Seq[FormError], B]

Binds this field, i.e. construct a concrete value from submitted data.

Binds this field, i.e. construct a concrete value from submitted data.

Value parameters

data

the submitted data

Attributes

Returns

either a concrete value of type B or a set of errors, if the binding failed

def unbind(value: B): Map[String, String]

Unbinds this field, i.e. transforms a concrete value to plain data.

Unbinds this field, i.e. transforms a concrete value to plain data.

Value parameters

value

the value to unbind

Attributes

Returns

the plain data

Unbinds this field, i.e. transforms a concrete value to plain data, and applies validation.

Unbinds this field, i.e. transforms a concrete value to plain data, and applies validation.

Value parameters

value

the value to unbind

Attributes

Returns

the plain data and any errors in the plain data

def verifying(constraints: Constraint[B]*): Mapping[B]

Constructs a new Mapping based on this one, by adding new constraints.

Constructs a new Mapping based on this one, by adding new constraints.

For example:

 import play.api.data._
 import validation.Constraints._

 Form("phonenumber" -> text.verifying(required) )

Value parameters

constraints

the constraints to add

Attributes

Returns

the new mapping

def withPrefix(prefix: String): Mapping[B]

Constructs a new Mapping based on this one, adding a prefix to the key.

Constructs a new Mapping based on this one, adding a prefix to the key.

Value parameters

prefix

the prefix to add to the key

Attributes

Returns

the same mapping, with only the key changed

Inherited methods

protected def addPrefix(prefix: String): Option[String]

Attributes

Inherited from:
Mapping
protected def applyConstraints(t: B): Either[Seq[FormError], T]

Attributes

Inherited from:
Mapping
protected def collectErrors(t: B): Seq[FormError]

Attributes

Inherited from:
Mapping

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
def transform[B](f1: B => B, f2: B => B): Mapping[B]

Transform this Mapping[T] to a Mapping[B].

Transform this Mapping[T] to a Mapping[B].

Type parameters

B

The type of the new mapping.

Value parameters

f1

Transform value of T to a value of B

f2

Transform value of B to a value of T

Attributes

Inherited from:
Mapping
def verifying(error: => String, constraint: B => Boolean): Mapping[T]

Constructs a new Mapping based on this one, by adding a new ad-hoc constraint.

Constructs a new Mapping based on this one, by adding a new ad-hoc constraint.

For example:

 import play.api.data._
 import validation.Constraints._

 Form("phonenumber" -> text.verifying("Bad phone number", {_.grouped(2).size == 5}))

Value parameters

constraint

a function describing the constraint that returns false on failure

error

The error message used if the constraint fails

Attributes

Returns

the new mapping

Inherited from:
Mapping
def verifying(constraint: B => Boolean): Mapping[T]

Constructs a new Mapping based on this one, by adding a new ad-hoc constraint.

Constructs a new Mapping based on this one, by adding a new ad-hoc constraint.

For example:

 import play.api.data._
 import validation.Constraints._

 Form("phonenumber" -> text.verifying {_.grouped(2).size == 5})

Value parameters

constraint

a function describing the constraint that returns false on failure

Attributes

Returns

the new mapping

Inherited from:
Mapping

Concrete fields

The constraints associated with this field.

The constraints associated with this field.

Attributes

override val format: Option[(String, Seq[Any])]

The Format expected for this field, if it exists.

The Format expected for this field, if it exists.

Attributes

val key: String

The field key.

The field key.

Attributes

val mappings: Seq[Mapping[_]]

Sub-mappings (these can be seen as sub-keys).

Sub-mappings (these can be seen as sub-keys).

Attributes