trait Mapping[T] extends AnyRef
A mapping is a two-way binder to handle a form field.
- Self Type
- Mapping[T]
- Source
- Form.scala
- Alphabetic
- By Inheritance
- Mapping
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def bind(data: Map[String, String]): Either[Seq[FormError], T]
Binds this field, i.e.
Binds this field, i.e. construct a concrete value from submitted data.
- data
the submitted data
- returns
either a concrete value of type
Tor a set of errors, if the binding failed
- abstract def constraints: Seq[Constraint[T]]
The constraints associated with this field.
- abstract def key: String
The field key.
- abstract def mappings: Seq[Mapping[_]]
Sub-mappings (these can be seen as sub-keys).
- abstract def unbind(value: T): Map[String, String]
Unbinds this field, i.e.
Unbinds this field, i.e. transforms a concrete value to plain data.
- value
the value to unbind
- returns
the plain data
- abstract def unbindAndValidate(value: T): (Map[String, String], Seq[FormError])
Unbinds this field, i.e.
Unbinds this field, i.e. transforms a concrete value to plain data, and applies validation.
- value
the value to unbind
- returns
the plain data and any errors in the plain data
- abstract def verifying(constraints: Constraint[T]*): Mapping[T]
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) )
- constraints
the constraints to add
- returns
the new mapping
- abstract def withPrefix(prefix: String): Mapping[T]
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.
- prefix
the prefix to add to the key
- returns
the same mapping, with only the key changed
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addPrefix(prefix: String): Option[String]
- Attributes
- protected
- def applyConstraints(t: T): Either[Seq[FormError], T]
- Attributes
- protected
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def collectErrors(t: T): Seq[FormError]
- Attributes
- protected
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def format: Option[(String, Seq[Any])]
The Format expected for this field, if it exists.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def transform[B](f1: (T) => B, f2: (B) => T): Mapping[B]
Transform this Mapping[T] to a Mapping[B].
Transform this Mapping[T] to a Mapping[B].
- B
The type of the new mapping.
- f1
Transform value of T to a value of B
- f2
Transform value of B to a value of T
- def verifying(error: => String, constraint: (T) => 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}))
- error
The error message used if the constraint fails
- constraint
a function describing the constraint that returns
falseon failure- returns
the new mapping
- def verifying(constraint: (T) => 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})
- constraint
a function describing the constraint that returns
falseon failure- returns
the new mapping
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()