Class

play.api.data

FieldMapping

Related Doc: package data

Permalink

case class FieldMapping[T](key: String = "", constraints: Seq[Constraint[T]] = Nil)(implicit binder: Formatter[T]) extends Mapping[T] with Product with Serializable

A mapping for a single field.

key

the field key

constraints

the constraints associated with this field.

Source
Form.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Mapping[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FieldMapping
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Mapping
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldMapping(key: String = "", constraints: Seq[Constraint[T]] = Nil)(implicit binder: Formatter[T])

    Permalink

    key

    the field key

    constraints

    the constraints associated with this field.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addPrefix(prefix: String): Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    Mapping
  5. def applyConstraints(t: T): Either[Seq[FormError], T]

    Permalink
    Attributes
    protected
    Definition Classes
    Mapping
  6. def as(binder: Formatter[T]): Mapping[T]

    Permalink

    Changes the binder used to handle this field.

    Changes the binder used to handle this field.

    binder

    the new binder to use

    returns

    the same mapping with a new binder

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def bind(data: Map[String, String]): Either[Seq[FormError], T]

    Permalink

    Binds this field, i.e.

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

    data

    the submitted data

    returns

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

    Definition Classes
    FieldMappingMapping
  9. implicit val binder: Formatter[T]

    Permalink
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collectErrors(t: T): Seq[FormError]

    Permalink
    Attributes
    protected
    Definition Classes
    Mapping
  12. val constraints: Seq[Constraint[T]]

    Permalink

    the constraints associated with this field.

    the constraints associated with this field.

    Definition Classes
    FieldMappingMapping
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val format: Option[(String, Seq[Any])]

    Permalink

    The Format expected for this field, if it exists.

    The Format expected for this field, if it exists.

    Definition Classes
    FieldMappingMapping
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val key: String

    Permalink

    the field key

    the field key

    Definition Classes
    FieldMappingMapping
  19. val mappings: Seq[Mapping[_]]

    Permalink

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

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

    Definition Classes
    FieldMappingMapping
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def transform[B](f1: (T) ⇒ B, f2: (B) ⇒ T): Mapping[B]

    Permalink

    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

    Definition Classes
    Mapping
  25. def unbind(value: T): Map[String, String]

    Permalink

    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

    Definition Classes
    FieldMappingMapping
  26. def unbindAndValidate(value: T): (Map[String, String], Seq[FormError])

    Permalink

    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

    Definition Classes
    FieldMappingMapping
  27. def verifying(addConstraints: Constraint[T]*): Mapping[T]

    Permalink

    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) )
    addConstraints

    the constraints to add

    returns

    the new mapping

    Definition Classes
    FieldMappingMapping
  28. def verifying(error: ⇒ String, constraint: (T) ⇒ Boolean): Mapping[T]

    Permalink

    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

    Definition Classes
    Mapping
  29. def verifying(constraint: (T) ⇒ Boolean): Mapping[T]

    Permalink

    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

    Definition Classes
    Mapping
  30. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def withPrefix(prefix: String): Mapping[T]

    Permalink

    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

    Definition Classes
    FieldMappingMapping

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Mapping[T]

Inherited from AnyRef

Inherited from Any

Ungrouped