play.api.libs.json

Reads

object Reads extends ConstraintReads with PathReads with DefaultReads

Default deserializer type classes.

Source
Reads.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Reads
  2. DefaultReads
  3. PathReads
  4. ConstraintReads
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Definition Classes
    AnyRef → Any
  4. implicit def ArrayReads[T](implicit arg0: Reads[T], arg1: ClassTag[T]): Reads[Array[T]]

    Deserializer for Array[T] types.

    Deserializer for Array[T] types.

    Definition Classes
    DefaultReads
  5. implicit object BooleanReads extends Reads[Boolean]

    Deserializer for Boolean types.

    Deserializer for Boolean types.

    Definition Classes
    DefaultReads
  6. implicit val DefaultDateReads: Reads[Date]

    the default implicit java.

    the default implicit java.util.Date reads

    Definition Classes
    DefaultReads
  7. implicit val DefaultJodaDateReads: Reads[DateTime]

    the default implicit JodaDate reads

    the default implicit JodaDate reads

    Definition Classes
    DefaultReads
  8. implicit val DefaultJodaLocalDateReads: Reads[LocalDate]

    the default implicit joda.

    the default implicit joda.time.LocalDate reads

    Definition Classes
    DefaultReads
  9. implicit val DefaultSqlDateReads: Reads[Date]

    the default implicit JodaDate reads

    the default implicit JodaDate reads

    Definition Classes
    DefaultReads
  10. implicit object DoubleReads extends Reads[Double]

    Deserializer for Double types.

    Deserializer for Double types.

    Definition Classes
    DefaultReads
  11. implicit object FloatReads extends Reads[Float]

    Deserializer for Float types.

    Deserializer for Float types.

    Definition Classes
    DefaultReads
  12. implicit object IntReads extends Reads[Int]

    Deserializer for Int types.

    Deserializer for Int types.

    Definition Classes
    DefaultReads
  13. val IsoDateReads: Reads[Date]

    ISO 8601 Reads

    ISO 8601 Reads

    Definition Classes
    DefaultReads
  14. implicit object JsArrayMonoid extends Monoid[JsArray]

  15. implicit object JsArrayReads extends Reads[JsArray]

    Definition Classes
    DefaultReads
  16. implicit val JsArrayReducer: Reducer[JsValue, JsArray]

  17. implicit object JsBooleanReads extends Reads[JsBoolean]

    Definition Classes
    DefaultReads
  18. def JsErrorObj(knownValue: JsValue, key: String, args: JsValue*): JsObject

    builds a JsErrorObj JsObject { VAL : "current known erroneous jsvalue", ERR : "the i18n key of the error msg", ARGS : "the args for the error msg" (JsArray) }

    builds a JsErrorObj JsObject { VAL : "current known erroneous jsvalue", ERR : "the i18n key of the error msg", ARGS : "the args for the error msg" (JsArray) }

    Definition Classes
    DefaultReads
  19. implicit object JsNumberReads extends Reads[JsNumber]

    Definition Classes
    DefaultReads
  20. implicit object JsObjectMonoid extends Monoid[JsObject]

  21. implicit object JsObjectReads extends Reads[JsObject]

    Deserializer for JsObject.

    Deserializer for JsObject.

    Definition Classes
    DefaultReads
  22. implicit val JsObjectReducer: Reducer[JsObject, JsObject]

  23. implicit object JsStringReads extends Reads[JsString]

    Definition Classes
    DefaultReads
  24. implicit object JsValueReads extends Reads[JsValue]

    Deserializer for JsValue.

    Deserializer for JsValue.

    Definition Classes
    DefaultReads
  25. implicit object LongReads extends Reads[Long]

    Deserializer for Long types.

    Deserializer for Long types.

    Definition Classes
    DefaultReads
  26. implicit def OptionReads[T](implicit fmt: Reads[T]): Reads[Option[T]]

    Definition Classes
    DefaultReads
  27. implicit object ShortReads extends Reads[Short]

    Deserializer for Short types.

    Deserializer for Short types.

    Definition Classes
    DefaultReads
  28. implicit object StringReads extends Reads[String]

    Deserializer for String types.

    Deserializer for String types.

    Definition Classes
    DefaultReads
  29. implicit def alternative(implicit a: Applicative[Reads]): Alternative[Reads]

  30. implicit def applicative(implicit applicativeJsResult: Applicative[JsResult]): Applicative[Reads]

  31. def apply[A](f: (JsValue) ⇒ JsResult[A]): Reads[A]

  32. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  33. def at[A](path: JsPath)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads
  34. implicit val bigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  35. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. val constraints: ConstraintReads

  37. def dateReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[Date]

    Reads for the java.util.Date type.

    Reads for the java.util.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
    DefaultReads
  38. def email(implicit reads: Reads[String]): Reads[String]

    Definition Classes
    ConstraintReads
  39. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  41. def filter[A](otherwise: ValidationError)(p: (A) ⇒ Boolean)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  42. def filterNot[A](error: ValidationError)(p: (A) ⇒ Boolean)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  43. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  44. implicit def functorReads(implicit a: Applicative[Reads]): Functor[Reads]

  45. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  48. implicit val javaBigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  49. def jodaDateReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[DateTime]

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

    Reads 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
    DefaultReads
  50. def jodaLocalDateReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[LocalDate]

    Reads for the org.joda.time.LocalDate type.

    Reads for the org.joda.time.LocalDate type.

    pattern

    a date pattern, as specified in org.joda.time.format.DateTimeFormat.

    corrector

    string transformation function (See jodaDateReads)

    Definition Classes
    DefaultReads
  51. def jsCopyTo[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads
  52. def jsPick[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads
  53. def jsPickBranch[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads
  54. def jsPrune(path: JsPath): Reads[JsObject]

    Definition Classes
    PathReads
  55. def jsPut(path: JsPath, a: ⇒ JsValue): Reads[JsObject]

    Definition Classes
    PathReads
  56. def jsUpdate[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads
  57. def list[A](implicit reads: Reads[A]): Reads[List[A]]

    Definition Classes
    ConstraintReads
  58. def map[A](implicit reads: Reads[A]): Reads[Map[String, A]]

    Definition Classes
    ConstraintReads
  59. implicit def mapReads[V](implicit fmtv: Reads[V]): Reads[Map[String, V]]

    Deserializer for Map[String,V] types.

    Deserializer for Map[String,V] types.

    Definition Classes
    DefaultReads
  60. def max[N](m: N)(implicit reads: Reads[N], num: Numeric[N]): Reads[N]

    Defines a maximum value for a numeric Reads.

    Defines a maximum value for a numeric Reads. Combine with min using or, e.g. .read(Reads.min(0.1) or Reads.max(1.0)).

    Definition Classes
    ConstraintReads
  61. def maxLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

    Definition Classes
    ConstraintReads
  62. def min[N](m: N)(implicit reads: Reads[N], num: Numeric[N]): Reads[N]

    Defines a minimum value for a numeric Reads.

    Defines a minimum value for a numeric Reads. Combine with max using or, e.g. .read(Reads.min(0) or Reads.max(100)).

    Definition Classes
    ConstraintReads
  63. def minLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

    Definition Classes
    ConstraintReads
  64. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  65. final def notify(): Unit

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

    Definition Classes
    AnyRef
  67. def nullable[A](path: JsPath)(implicit reads: Reads[A]): Reads[Option[A]]

    Reads a Option[T] search optional or nullable field at JsPath (field not found or null is None and other cases are Error).

    Reads a Option[T] search optional or nullable field at JsPath (field not found or null is None and other cases are Error).

    It runs through JsValue following all JsPath nodes on JsValue except last node: - If one node in JsPath is not found before last node => returns JsError( "missing-path" ) - If all nodes are found till last node, it runs through JsValue with last node =>

    • If last node if not found => returns None
    • If last node is found with value "null" => returns None
    • If last node is found => applies implicit Reads[T]
    Definition Classes
    PathReads
  68. def of[A](implicit r: Reads[A]): Reads[A]

    The simpler of all Reads that just finds an implicit Reads[A] of the expected type

    The simpler of all Reads that just finds an implicit Reads[A] of the expected type

    Definition Classes
    ConstraintReads
  69. def optionNoError[A](implicit reads: Reads[A]): Reads[Option[A]]

    Stupidly reads a field as an Option mapping any error (format or missing field) to None

    Stupidly reads a field as an Option mapping any error (format or missing field) to None

    Definition Classes
    ConstraintReads
  70. def optionWithNull[T](implicit rds: Reads[T]): Reads[Option[T]]

    very simple optional field Reads that maps "null" to None

    very simple optional field Reads that maps "null" to None

    Definition Classes
    ConstraintReads
  71. val path: PathReads

  72. def pattern(regex: ⇒ Regex, error: String = "error.pattern")(implicit reads: Reads[String]): Reads[String]

    Defines a regular expression constraint for String values, i.

    Defines a regular expression constraint for String values, i.e. the string must match the regular expression pattern

    Definition Classes
    ConstraintReads
  73. def pure[A](a: ⇒ A): Reads[A]

    Definition Classes
    ConstraintReads
  74. def required(path: JsPath)(implicit reads: Reads[JsValue]): Reads[JsValue]

    Definition Classes
    PathReads
  75. def seq[A](implicit reads: Reads[A]): Reads[Seq[A]]

    Definition Classes
    ConstraintReads
  76. def set[A](implicit reads: Reads[A]): Reads[Set[A]]

    Definition Classes
    ConstraintReads
  77. def sqlDateReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[Date]

    Reads for the java.sql.Date type.

    Reads 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
    DefaultReads
  78. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  79. def toString(): String

    Definition Classes
    AnyRef → Any
  80. implicit def traversableReads[F[_], A](implicit bf: CanBuildFrom[F[_], A, F[A]], ra: Reads[A]): Reads[F[A]]

    Generic deserializer for collections types.

    Generic deserializer for collections types.

    Definition Classes
    DefaultReads
  81. def uuidReader(checkUuuidValidity: Boolean = false): Reads[UUID]

    Deserializer for java.

    Deserializer for java.util.UUID

    Definition Classes
    DefaultReads
  82. implicit val uuidReads: Reads[UUID]

    Definition Classes
    DefaultReads
  83. def verifying[A](cond: (A) ⇒ Boolean)(implicit rds: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  84. def verifyingIf[A](cond: (A) ⇒ Boolean)(subreads: Reads[_])(implicit rds: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  85. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def optional[A](path: JsPath)(implicit reads: Reads[A]): Reads[Option[A]]

    Reads optional field at JsPath.

    Reads optional field at JsPath. If JsPath is not found => None If JsPath is found => applies implicit Reads[T]

    Definition Classes
    PathReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1-RC2) use nullable[T] instead

Inherited from DefaultReads

Inherited from PathReads

Inherited from ConstraintReads

Inherited from AnyRef

Inherited from Any

Ungrouped