Packages

c

play.api.data

ObjectMapping3

class ObjectMapping3[R, A1, A2, A3] extends Mapping[R] with ObjectMapping

Source
ObjectMappings.scala
Linear Supertypes
ObjectMapping, Mapping[R], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjectMapping3
  2. ObjectMapping
  3. Mapping
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ObjectMapping3(apply: (A1, A2, A3) ⇒ R, unapply: (R) ⇒ Option[(A1, A2, A3)], f1: (String, Mapping[A1]), f2: (String, Mapping[A2]), f3: (String, Mapping[A3]), key: String = "", constraints: Seq[Constraint[R]] = Nil)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addPrefix(prefix: String): Option[String]
    Attributes
    protected
    Definition Classes
    Mapping
  5. def applyConstraints(t: R): Either[Seq[FormError], R]
    Attributes
    protected
    Definition Classes
    Mapping
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def bind(data: Map[String, String]): Either[Seq[FormError], R]

    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

    Definition Classes
    ObjectMapping3 → Mapping
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def collectErrors(t: R): Seq[FormError]
    Attributes
    protected
    Definition Classes
    Mapping
  10. val constraints: Seq[Constraint[R]]

    The constraints associated with this field.

    The constraints associated with this field.

    Definition Classes
    ObjectMapping3 → Mapping
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. val field1: Mapping[A1]
  14. val field2: Mapping[A2]
  15. val field3: Mapping[A3]
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. 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
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val key: String

    The field key.

    The field key.

    Definition Classes
    ObjectMapping3 → Mapping
  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
    ObjectMapping3 → Mapping
  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
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. 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
  31. def unbind(value: R): 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

    Definition Classes
    ObjectMapping3 → Mapping
  32. def unbindAndValidate(value: R): (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

    Definition Classes
    ObjectMapping3 → Mapping
  33. def verifying(addConstraints: Constraint[R]*): ObjectMapping3[R, A1, A2, A3]

    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
    ObjectMapping3 → Mapping
  34. 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
  35. 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
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  39. def withPrefix(prefix: String): ObjectMapping3[R, A1, A2, A3]

    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
    ObjectMapping3 → Mapping

Inherited from ObjectMapping

Inherited from Mapping[R]

Inherited from AnyRef

Inherited from Any

Ungrouped