t

play.api.data

Mapping

trait Mapping[T] extends AnyRef

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mapping
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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 T or a set of errors, if the binding failed

  2. abstract def constraints: Seq[Constraint[T]]

    The constraints associated with this field.

  3. abstract def key: String

    The field key.

  4. abstract def mappings: Seq[Mapping[_]]

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

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

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

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

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

  1. def format: Option[(String, Seq[Any])]

    The Format expected for this field, if it exists.

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

  3. 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 false on failure

    returns

    the new mapping

  4. 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 false on failure

    returns

    the new mapping