Class

play.api.data

OptionalMapping

Related Doc: package data

Permalink

case class OptionalMapping[T](wrapped: Mapping[T], constraints: Seq[Constraint[Option[T]]] = Nil) extends Mapping[Option[T]] with Product with Serializable

A mapping for optional elements

wrapped

the wrapped mapping

Source
Form.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Mapping[Option[T]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OptionalMapping
  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 OptionalMapping(wrapped: Mapping[T], constraints: Seq[Constraint[Option[T]]] = Nil)

    Permalink

    wrapped

    the wrapped mapping

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

    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], Option[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 error if the binding failed

    Definition Classes
    OptionalMappingMapping
  8. def clone(): AnyRef

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

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

    Permalink

    The constraints associated with this field.

    The constraints associated with this field.

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. 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
    OptionalMappingMapping
  14. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  16. val key: String

    Permalink

    The field key.

    The field key.

    Definition Classes
    OptionalMappingMapping
  17. 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
    OptionalMappingMapping
  18. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  22. def transform[B](f1: (Option[T]) ⇒ B, f2: (B) ⇒ Option[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
  23. def unbind(value: Option[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
    OptionalMappingMapping
  24. def unbindAndValidate(value: Option[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
    OptionalMappingMapping
  25. def verifying(addConstraints: Constraint[Option[T]]*): Mapping[Option[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
    OptionalMappingMapping
  26. def verifying(error: ⇒ String, constraint: (Option[T]) ⇒ Boolean): Mapping[Option[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
  27. def verifying(constraint: (Option[T]) ⇒ Boolean): Mapping[Option[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
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withPrefix(prefix: String): Mapping[Option[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
    OptionalMappingMapping
  32. val wrapped: Mapping[T]

    Permalink

    the wrapped mapping

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Mapping[Option[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped