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
- Alphabetic
- By Inheritance
- FieldMapping
- Serializable
- Serializable
- Product
- Equals
- Mapping
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
FieldMapping(key: String = "", constraints: Seq[Constraint[T]] = Nil)(implicit binder: Formatter[T])
- key
the field key
- constraints
the constraints associated with this field.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addPrefix(prefix: String): Option[String]
- Attributes
- protected
- Definition Classes
- Mapping
-
def
applyConstraints(t: T): Either[Seq[FormError], T]
- Attributes
- protected
- Definition Classes
- Mapping
-
def
as(binder: Formatter[T]): Mapping[T]
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bind(data: Map[String, String]): Either[Seq[FormError], T]
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
Tor a set of errors, if binding failed
- Definition Classes
- FieldMapping → Mapping
- implicit val binder: Formatter[T]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
collectErrors(t: T): Seq[FormError]
- Attributes
- protected
- Definition Classes
- Mapping
-
val
constraints: Seq[Constraint[T]]
The constraints associated with this field.
The constraints associated with this field.
- Definition Classes
- FieldMapping → Mapping
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
- FieldMapping → Mapping
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
key: String
The field key.
The field key.
- Definition Classes
- FieldMapping → Mapping
-
val
mappings: Seq[Mapping[_]]
Sub-mappings (these can be seen as sub-keys).
Sub-mappings (these can be seen as sub-keys).
- Definition Classes
- FieldMapping → Mapping
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
transform[B](f1: (T) ⇒ B, f2: (B) ⇒ T): 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
-
def
unbind(value: T): 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
- FieldMapping → Mapping
-
def
unbindAndValidate(value: T): (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
- FieldMapping → Mapping
-
def
verifying(addConstraints: Constraint[T]*): Mapping[T]
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
- FieldMapping → Mapping
-
def
verifying(error: ⇒ String, constraint: (T) ⇒ Boolean): Mapping[T]
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
falseon failure- returns
the new mapping
- Definition Classes
- Mapping
-
def
verifying(constraint: (T) ⇒ Boolean): Mapping[T]
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
falseon failure- returns
the new mapping
- Definition Classes
- Mapping
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withPrefix(prefix: String): Mapping[T]
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
- FieldMapping → Mapping