Class

play.api.data

ObjectMapping1

Related Doc: package data

Permalink

class ObjectMapping1[R, A1] extends Mapping[R] with ObjectMapping

Source
ObjectMappings.scala
Linear Supertypes
ObjectMapping, Mapping[R], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjectMapping1
  2. ObjectMapping
  3. Mapping
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
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]] = Nil)

    Permalink

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: R): Either[Seq[FormError], R]

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

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

    Permalink

    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
    ObjectMapping1Mapping
  8. def clone(): AnyRef

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

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

    Permalink

    The constraints associated with this field.

    The constraints associated with this field.

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

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. val field1: Mapping[A1]

    Permalink
  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
    Mapping
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  19. val key: String

    Permalink

    The field key.

    The field key.

    Definition Classes
    ObjectMapping1Mapping
  20. 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
    ObjectMapping1Mapping
  21. def merge(results: Either[Seq[FormError], Any]*): Either[Seq[FormError], Seq[Any]]

    Permalink

    Merges the result of multiple bindings.

    Merges the result of multiple bindings.

    Definition Classes
    ObjectMapping
    See also

    bind()

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

    Permalink

    Merges the result of two bindings.

    Merges the result of two bindings.

    Definition Classes
    ObjectMapping
    See also

    bind()

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. def transform[B](f1: (R) ⇒ B, f2: (B) ⇒ R): 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
  29. def unbind(value: R): 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
    ObjectMapping1Mapping
  30. def unbindAndValidate(value: R): (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
    ObjectMapping1Mapping
  31. def verifying(addConstraints: Constraint[R]*): ObjectMapping1[R, A1]

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

    the new mapping

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

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

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

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

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

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

    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
    ObjectMapping1Mapping

Inherited from ObjectMapping

Inherited from Mapping[R]

Inherited from AnyRef

Inherited from Any

Ungrouped