play.api.data.mapping

DefaultRules

trait DefaultRules[I] extends GenericRules with DateRules

DefaultRules provides basic rules implementations for inputs of type I Extends this trait if your implementing a new set of Rules for I.

Linear Supertypes
DateRules, GenericRules, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DefaultRules
  2. DateRules
  3. GenericRules
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. implicit def arrayR[I, O](implicit arg0: ClassTag[O], r: RuleLike[I, O]): Rule[Seq[I], Array[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Array[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Array[O]]

    (Path \ "foo").read(array(notEmpty)) // create a Rules validating that an Array contains non-empty Strings
    r

    A Rule[I, O] to lift

    returns

    A new Rule

    Definition Classes
    GenericRules
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def checked[I](implicit b: RuleLike[I, Boolean]): Rule[I, Boolean]

    A Rule for HTML checkboxes

    A Rule for HTML checkboxes

    Definition Classes
    GenericRules
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def date(format: String = "yyyy-MM-dd", corrector: (String) ⇒ String = identity): Rule[String, Date]

    Rule for the java.util.Date type.

    Rule for the java.util.Date type.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    DateRules
  11. implicit val date: Rule[String, Date]

    default Rule for the java.util.Date type.

    default Rule for the java.util.Date type. It uses the default date format: yyyy-MM-dd

    Definition Classes
    DateRules
  12. def email: Rule[String, String]

    Validate that a String is a valid email

    Validate that a String is a valid email

    (Path \ "email").read(email) // This String is an email
    Definition Classes
    GenericRules
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equalTo[T](t: T): Rule[T, T]

    Create a Rule of equality

    Create a Rule of equality

    (Path \ "foo").read(equalTo("bar"))
    Definition Classes
    GenericRules
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  19. implicit def headAs[I, O](implicit c: RuleLike[I, O]): Rule[Seq[I], O]

    Create a Rule validation that a Seq[I] is not empty, and attempt to convert it's first element as a O

    Create a Rule validation that a Seq[I] is not empty, and attempt to convert it's first element as a O

    (Path \ "foo").read(headAs(int))
    Definition Classes
    GenericRules
  20. def ignored[I, O](o: O): (Path) ⇒ Rule[I, O]

    Create a "constant" Rule which is always a success returning value o (Path \ "x").

    Create a "constant" Rule which is always a success returning value o (Path \ "x").read(ignored(42))

    Definition Classes
    GenericRules
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. val isoDate: Rule[String, Date]

    ISO 8601 Reads

    ISO 8601 Reads

    Definition Classes
    DateRules
  23. implicit val jodaDate: Rule[String, DateTime]

    the default implicit JodaDate reads It uses the default date format: yyyy-MM-dd

    the default implicit JodaDate reads It uses the default date format: yyyy-MM-dd

    Definition Classes
    DateRules
  24. def jodaDateRule(pattern: String, corrector: (String) ⇒ String = identity): Rule[String, DateTime]

    Rule for the org.joda.time.DateTime type.

    Rule for the org.joda.time.DateTime type.

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    DateRules
  25. implicit val jodaLocalDate: Rule[String, LocalDate]

    the default implicit Rule for org.joda.time.LocalDate

    the default implicit Rule for org.joda.time.LocalDate

    Definition Classes
    DateRules
  26. implicit def jodaLocalDateRule(pattern: String, corrector: (String) ⇒ String = identity): Rule[String, LocalDate]

    Definition Classes
    DateRules
  27. implicit def jodaTime: Rule[Long, DateTime]

    default Rule for the java.util.DateTime type.

    default Rule for the java.util.DateTime type.

    Definition Classes
    DateRules
  28. implicit def listR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], List[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], List[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], List[O]]

    (Path \ "foo").read(list(notEmpty)) // create a Rules validating that an List contains non-empty Strings
    r

    A Rule[I, O] to lift

    returns

    A new Rule

    Definition Classes
    GenericRules
  29. def mapR[K, O](r: RuleLike[K, O], p: RuleLike[I, Seq[(String, K)]]): Rule[I, Map[String, O]]

  30. def max[T](m: T)(implicit o: Ordering[T]): Rule[T, T]

    (Path \ "foo").read(max(0)) // validate that there's a negative int at (Path \ "foo")
    Definition Classes
    GenericRules
  31. def maxLength(l: Int): Rule[String, String]

    (Path \ "foo").read(maxLength(5)) // The length of this String must be <= 5
    Definition Classes
    GenericRules
  32. def min[T](m: T)(implicit o: Ordering[T]): Rule[T, T]

    (Path \ "foo").read(min(0)) // validate that there's a positive int at (Path \ "foo")
    Definition Classes
    GenericRules
  33. def minLength(l: Int): Rule[String, String]

    (Path \ "foo").read(minLength(5)) // The length of this String must be >= 5
    Definition Classes
    GenericRules
  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. def noConstraint[From]: (From) ⇒ Validation[ValidationError, From]

    A Rule that always succeed

    A Rule that always succeed

    Definition Classes
    GenericRules
  36. def not[I, O](r: RuleLike[I, O]): Rule[I, I]

    Definition Classes
    GenericRules
  37. def notEmpty: Rule[String, String]

    a Rule validating that a String is not empty.

    a Rule validating that a String is not empty.

    Definition Classes
    GenericRules
    Note

    This Rule does NOT trim the String beforehand

    (Path \ "foo").read(notEmpty)
  38. final def notify(): Unit

    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  40. def opt[J, O](r: ⇒ RuleLike[J, O], noneValues: RuleLike[I, I]*)(implicit pick: (Path) ⇒ RuleLike[I, I], coerce: RuleLike[I, J]): (Path) ⇒ Rule[I, Option[O]]

    Attributes
    protected
  41. def pattern(regex: Regex): Rule[String, String]

    Validate that a String matches the provided regex

    Validate that a String matches the provided regex

    (Path \ "foo").read(pattern("[a-z]".r)) // This String contains only letters
    Definition Classes
    GenericRules
  42. implicit def seqR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], Seq[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Seq[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Seq[O]]

    (Path \ "foo").read(seq(notEmpty)) // create a Rules validating that an Seq contains non-empty Strings
    r

    A Rule[I, O] to lift

    returns

    A new Rule

    Definition Classes
    GenericRules
  43. implicit def setR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], Set[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Set[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Set[O]]

    (Path \ "foo").read(set(notEmpty)) // create a Rules validating that a Set contains non-empty Strings
    r

    A Rule[I, O] to lift

    returns

    A new Rule

    Definition Classes
    GenericRules
  44. implicit val sqlDate: Rule[String, Date]

    the default implicit Rule for java.sql.Date

    the default implicit Rule for java.sql.Date

    Definition Classes
    DateRules
  45. def sqlDateRule(pattern: String, corrector: (String) ⇒ String = identity): Rule[String, Date]

    Rule for the java.sql.Date type.

    Rule for the java.sql.Date type.

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    DateRules
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  47. def toString(): String

    Definition Classes
    AnyRef → Any
  48. implicit def traversableR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], Traversable[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Traversable[O]]

    lift a Rule[I, O] to a Rule of Rule[Seq[I], Traversable[O]]

    (Path \ "foo").read(traversable(notEmpty)) // create a Rules validating that an Traversable contains non-empty Strings
    r

    A Rule[I, O] to lift

    returns

    A new Rule

    Definition Classes
    GenericRules
  49. def validateWith[I](msg: String, args: Any*)(pred: (I) ⇒ Boolean): Rule[I, I]

    Create a new constraint, verifying that the provided predicate is satisfied.

    Create a new constraint, verifying that the provided predicate is satisfied.

    def notEmpty = validateWith[String]("validation.nonemptytext"){ !_.isEmpty }
    msg

    The error message to return if predicate pred is not satisfied

    args

    Arguments for the ValidationError

    pred

    A predicate to satify

    returns

    A new Rule validating data of type I against a predicate p

    Definition Classes
    GenericRules
  50. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from DateRules

Inherited from GenericRules

Inherited from AnyRef

Inherited from Any

Ungrouped