OptionalMapping

Instance Constructors

new OptionalMapping(wrapped: Mapping[T], constraints: Seq[Constraint[Option[T]]] = Nil)

wrapped
the wrapped mapping

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

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

Definition Classes
Any
def bind(data: Map[String, String]): Either[Seq[FormError], Option[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 T or a set of error if the binding failed

Definition Classes
OptionalMapping → Mapping
def clone(): AnyRef

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

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

The constraints associated with this field.
The constraints associated with this field.

Definition Classes
OptionalMapping → Mapping
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.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
OptionalMapping → Mapping
final def getClass(): Class[_]

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

Definition Classes
Any
val key: String

The field key.
The field key.

Definition Classes
OptionalMapping → 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
OptionalMapping → Mapping
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def transform[B](f1: (Option[T]) ⇒ B, f2: (B) ⇒ Option[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: Option[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
OptionalMapping → Mapping
def unbindAndValidate(value: Option[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
OptionalMapping → Mapping
def verifying(addConstraints: Constraint[Option[T]]*): Mapping[Option[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
OptionalMapping → Mapping
def verifying(error: ⇒ String, constraint: (Option[T]) ⇒ Boolean): Mapping[Option[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 false on failure
returns
the new mapping

Definition Classes
Mapping
def verifying(constraint: (Option[T]) ⇒ Boolean): Mapping[Option[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 false on 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( ... )
def withPrefix(prefix: String): Mapping[Option[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
OptionalMapping → Mapping
val wrapped: Mapping[T]

the wrapped mapping

Related Doc: package data

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

Instance Constructors

new OptionalMapping(wrapped: Mapping[T], constraints: Seq[Constraint[Option[T]]] = Nil)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addPrefix(prefix: String): Option[String]

def applyConstraints(t: Option[T]): Either[Seq[FormError], Option[T]]

final def asInstanceOf[T0]: T0

def bind(data: Map[String, String]): Either[Seq[FormError], Option[T]]

def clone(): AnyRef

def collectErrors(t: Option[T]): Seq[FormError]

val constraints: Seq[Constraint[Option[T]]]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val format: Option[(String, Seq[Any])]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val key: String

val mappings: Seq[Mapping[_]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def transform[B](f1: (Option[T]) ⇒ B, f2: (B) ⇒ Option[T]): Mapping[B]

def unbind(value: Option[T]): Map[String, String]

def unbindAndValidate(value: Option[T]): (Map[String, String], Seq[FormError])

def verifying(addConstraints: Constraint[Option[T]]*): Mapping[Option[T]]

def verifying(error: ⇒ String, constraint: (Option[T]) ⇒ Boolean): Mapping[Option[T]]

def verifying(constraint: (Option[T]) ⇒ Boolean): Mapping[Option[T]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withPrefix(prefix: String): Mapping[Option[T]]

val wrapped: Mapping[T]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Mapping[Option[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped