play.api.data

ObjectMapping1

case class ObjectMapping1[R, A1](apply: (A1) ⇒ R, unapply: (R) ⇒ Option[A1], f1: (String, Mapping[A1]), key: String = "", constraints: Seq[Constraint[R]] = immutable.this.Nil) extends Mapping[R] with ObjectMapping with Product with Serializable

Represents an object binding (ie. a binding for several fields).

This is used for objects with one field. Other versions exist, e.g. ObjectMapping2, ObjectMapping3, etc.

apply

a constructor function that creates a instance of T using field A

constraints

constraints associated with this mapping

Source
Form.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ObjectMapping, Mapping[R], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ObjectMapping1
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ObjectMapping
  7. Mapping
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ObjectMapping1(apply: (A1) ⇒ R, unapply: (R) ⇒ Option[A1], f1: (String, Mapping[A1]), key: String = "", constraints: Seq[Constraint[R]] = immutable.this.Nil)

    apply

    a constructor function that creates a instance of T using field A

    constraints

    constraints associated with this mapping

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addPrefix(prefix: String): Option[String]

    Attributes
    protected
    Definition Classes
    Mapping
  7. val apply: (A1) ⇒ R

    a constructor function that creates a instance of T using field A

  8. def applyConstraints(t: R): Either[Seq[FormError], R]

    Attributes
    protected
    Definition Classes
    Mapping
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def bind(data: Map[String, String]): Either[Seq[FormError], R]

    Binds this field, i.

    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

    Definition Classes
    ObjectMapping1Mapping
  11. def clone(): AnyRef

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

    Attributes
    protected
    Definition Classes
    Mapping
  13. val constraints: Seq[Constraint[R]]

    constraints associated with this mapping

    constraints associated with this mapping

    Definition Classes
    ObjectMapping1Mapping
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. val f1: (String, Mapping[A1])

  16. val field1: Mapping[A1]

  17. def finalize(): Unit

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

    The Format expected for this field, if it exists.

    The Format expected for this field, if it exists.

    Definition Classes
    Mapping
  19. final def getClass(): Class[_]

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

    Definition Classes
    Any
  21. val key: String

    The field key.

    The field key.

    Definition Classes
    ObjectMapping1Mapping
  22. val mappings: Seq[Mapping[_]]

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

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

    Definition Classes
    ObjectMapping1Mapping
  23. def merge(results: Either[Seq[FormError], Any]*): Either[Seq[FormError], Seq[Any]]

    Merges the result of multiple bindings.

    Merges the result of multiple bindings.

    Definition Classes
    ObjectMapping
    See also

    bind()

  24. def merge2(a: Either[Seq[FormError], Seq[Any]], b: Either[Seq[FormError], Seq[Any]]): Either[Seq[FormError], Seq[Any]]

    Merges the result of two bindings.

    Merges the result of two bindings.

    Definition Classes
    ObjectMapping
    See also

    bind()

  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  29. def transform[B](f1: (R) ⇒ B, f2: (B) ⇒ R): 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

    Definition Classes
    Mapping
  30. val unapply: (R) ⇒ Option[A1]

  31. def unbind(value: R): (Map[String, String], Seq[FormError])

    Unbinds this field, i.

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

    value

    the value to unbind

    returns

    either the plain data or a set of errors, if the unbinding failed

    Definition Classes
    ObjectMapping1Mapping
  32. def verifying(addConstraints: Constraint[R]*): ObjectMapping1[R, A1]

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

    the new mapping

    Definition Classes
    ObjectMapping1Mapping
  33. def verifying(error: ⇒ String, constraint: (R) ⇒ Boolean): Mapping[R]

    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
  34. def verifying(constraint: (R) ⇒ Boolean): Mapping[R]

    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
  35. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def withPrefix(prefix: String): ObjectMapping1[R, A1]

    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
    ObjectMapping1Mapping

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ObjectMapping

Inherited from Mapping[R]

Inherited from AnyRef

Inherited from Any

Ungrouped