Object/Trait

play.api.libs.json

Reads

Related Docs: trait Reads | package json

Permalink

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. LowPriorityDefaultReads
  4. PathReads
  5. ConstraintReads
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. trait TemporalParser[T <: Temporal] extends AnyRef

    Permalink

    Typeclass to implement way of parsing string as Java8 temporal types.

    Typeclass to implement way of parsing string as Java8 temporal types.

    Definition Classes
    DefaultReads
  2. class UUIDReader extends Reads[UUID]

    Permalink

    Deserializer for java.util.UUID

    Deserializer for java.util.UUID

    Definition Classes
    DefaultReads

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. implicit object ArrayNodeReads extends Reads[ArrayNode]

    Permalink

    Deserializer for Jackson ArrayNode

    Deserializer for Jackson ArrayNode

    Definition Classes
    DefaultReads
  5. implicit def ArrayReads[T](implicit arg0: Reads[T], arg1: ClassTag[T]): Reads[Array[T]]

    Permalink

    Deserializer for Array[T] types.

    Deserializer for Array[T] types.

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

    Permalink

    Deserializer for Boolean types.

    Deserializer for Boolean types.

    Definition Classes
    DefaultReads
  7. implicit object ByteReads extends Reads[Byte]

    Permalink

    Deserializer for Byte types.

    Deserializer for Byte types.

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

    Permalink

    the default implicit java.util.Date reads

    the default implicit java.util.Date reads

    Definition Classes
    DefaultReads
  9. implicit val DefaultInstantReads: Reads[Instant]

    Permalink

    The default typeclass to reads java.time.Instant from JSON.

    The default typeclass to reads java.time.Instant from JSON. Accepts instant formats as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

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

    Permalink

    the default implicit JodaDate reads

    the default implicit JodaDate reads

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

    Permalink

    the default implicit joda.time.LocalDate reads

    the default implicit joda.time.LocalDate reads

    Definition Classes
    DefaultReads
  12. implicit val DefaultJodaLocalTimeReads: Reads[LocalTime]

    Permalink

    the default implicit joda.time.LocalTime reads

    the default implicit joda.time.LocalTime reads

    Definition Classes
    DefaultReads
  13. implicit val DefaultLocalDateReads: Reads[LocalDate]

    Permalink

    The default typeclass to reads java.time.LocalDate from JSON.

    The default typeclass to reads java.time.LocalDate from JSON. Accepts date formats as '2011-12-03'.

    Definition Classes
    DefaultReads
  14. implicit val DefaultLocalDateTimeReads: Reads[LocalDateTime]

    Permalink

    The default typeclass to reads java.time.LocalDateTime from JSON.

    The default typeclass to reads java.time.LocalDateTime from JSON. Accepts date/time formats as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

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

    Permalink

    the default implicit JodaDate reads

    the default implicit JodaDate reads

    Definition Classes
    DefaultReads
  16. implicit val DefaultZonedDateTimeReads: Reads[ZonedDateTime]

    Permalink

    The default typeclass to reads java.time.ZonedDateTime from JSON.

    The default typeclass to reads java.time.ZonedDateTime from JSON. Accepts date/time formats as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

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

    Permalink

    Deserializer for Double types.

    Deserializer for Double types.

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

    Permalink

    Deserializer for Float types.

    Deserializer for Float types.

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

    Permalink

    Deserializer for Int types.

    Deserializer for Int types.

    Definition Classes
    DefaultReads
  20. object IsoDateReads extends Reads[Date]

    Permalink

    ISO 8601 Reads

    ISO 8601 Reads

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

    Permalink
  22. implicit object JsArrayReads extends Reads[JsArray]

    Permalink

    Deserializer for JsArray.

    Deserializer for JsArray.

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

    Permalink
  24. implicit object JsBooleanReads extends Reads[JsBoolean]

    Permalink

    Deserializer for JsBoolean.

    Deserializer for JsBoolean.

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

    Permalink

    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
  26. implicit object JsNumberReads extends Reads[JsNumber]

    Permalink

    Deserializer for JsNumber.

    Deserializer for JsNumber.

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

    Permalink
  28. implicit object JsObjectReads extends Reads[JsObject]

    Permalink

    Deserializer for JsObject.

    Deserializer for JsObject.

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

    Permalink
  30. implicit object JsStringReads extends Reads[JsString]

    Permalink

    Deserializer for JsString.

    Deserializer for JsString.

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

    Permalink

    Deserializer for JsValue.

    Deserializer for JsValue.

    Definition Classes
    DefaultReads
  32. implicit object JsonNodeReads extends Reads[JsonNode]

    Permalink

    Deserializer for Jackson JsonNode

    Deserializer for Jackson JsonNode

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

    Permalink

    Deserializer for Long types.

    Deserializer for Long types.

    Definition Classes
    DefaultReads
  34. implicit object ObjectNodeReads extends Reads[ObjectNode]

    Permalink

    Deserializer for Jackson ObjectNode

    Deserializer for Jackson ObjectNode

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

    Permalink

    Deserializer for Short types.

    Deserializer for Short types.

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

    Permalink

    Deserializer for String types.

    Deserializer for String types.

    Definition Classes
    DefaultReads
  37. object TemporalParser

    Permalink

    Parsing companion

    Parsing companion

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

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

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

    Permalink
  41. final def asInstanceOf[T0]: T0

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

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

    Permalink

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  44. def clone(): AnyRef

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

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

    Permalink

    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
  47. def email(implicit reads: Reads[String]): Reads[String]

    Permalink
    Definition Classes
    ConstraintReads
  48. def enumNameReads[E <: Enumeration](enum: E): Reads[DefaultReads.enumNameReads.E.Value]

    Permalink

    Reads for scala.Enumeration types using the name.

    Reads for scala.Enumeration types using the name.

    enum

    a scala.Enumeration.

    Definition Classes
    DefaultReads
  49. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    ConstraintReads
  53. def finalize(): Unit

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

    Permalink
  55. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  57. def instantReads[T](parsing: T, corrector: (String) ⇒ String = identity)(implicit p: (T) ⇒ TemporalParser[Instant]): Reads[Instant]

    Permalink

    Reads for the java.time.Instant type.

    Reads for the java.time.Instant type. When input value doesn't specify the time zone, then java.time.ZoneId.systemDefault is used.

    T

    Type of argument to instantiate date parser

    parsing

    Argument to instantiate date parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    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. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    DefaultReads
    See also

    TemporalFormatter

    import play.api.libs.json.Java8Reads.instantReads
    val customReads1 = instantReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = instantReads(DateTimeFormatter.ISO_INSTANT)
    val customReads3 = instantReads(DateTimeFormatter.ISO_INSTANT, _.drop(1))
  58. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Deserializer for BigDecimal

    Deserializer for BigDecimal

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

    Permalink

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

    Permalink

    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
  62. def jodaLocalTimeReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[LocalTime]

    Permalink

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

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

    pattern

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

    corrector

    string transformation function (See jodaTimeReads)

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ConstraintReads
  70. def localDateReads[T](parsing: T, corrector: (String) ⇒ String = identity)(implicit p: (T) ⇒ TemporalParser[LocalDate]): Reads[LocalDate]

    Permalink

    Reads for the java.time.LocalDate type.

    Reads for the java.time.LocalDate type. When input value doesn't specify the time zone, then java.time.ZoneId.systemDefault is used.

    T

    Type of argument to instantiate date parser

    parsing

    Argument to instantiate date parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    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. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    DefaultReads
    See also

    TemporalFormatter

    import play.api.libs.json.Java8Reads.localDateReads
    val customReads1 = localDateReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = localDateReads(DateTimeFormatter.ISO_DATE)
    val customReads3 = localDateReads(DateTimeFormatter.ISO_DATE, _.drop(1))
  71. def localDateTimeReads[T](parsing: T, corrector: (String) ⇒ String = identity)(implicit p: (T) ⇒ TemporalParser[LocalDateTime]): Reads[LocalDateTime]

    Permalink

    Reads for the java.time.LocalDateTime type.

    Reads for the java.time.LocalDateTime type. When input value doesn't specify the time zone, then java.time.ZoneId.systemDefault is used.

    T

    Type of argument to instantiate date/time parser

    parsing

    Argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    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. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    DefaultReads
    See also

    TemporalFormatter

    import play.api.libs.json.Java8Reads.localDateTimeReads
    val customReads1 = localDateTimeReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = localDateTimeReads(DateTimeFormatter.ISO_DATE_TIME)
    val customReads3 = localDateTimeReads(
      DateTimeFormatter.ISO_DATE_TIME, _.drop(1))
  72. def map[A](implicit reads: Reads[A]): Reads[Map[String, A]]

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

    Permalink

    Deserializer for Map[String,V] types.

    Deserializer for Map[String,V] types.

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

    Permalink

    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
  75. def maxLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

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

    Permalink

    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
  77. def minLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

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

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

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

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

    Permalink

    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
  82. def of[A](implicit r: Reads[A]): Reads[A]

    Permalink

    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
  83. def optionNoError[A](implicit reads: Reads[A]): Reads[Option[A]]

    Permalink

    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
  84. def optionWithNull[T](implicit rds: Reads[T]): Reads[Option[T]]

    Permalink

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

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

    Definition Classes
    ConstraintReads
  85. val path: PathReads

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

    Permalink

    Defines a regular expression constraint for String values, i.e.

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

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

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

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

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

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  93. def toString(): String

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

    Permalink

    Generic deserializer for collections types.

    Generic deserializer for collections types.

    Definition Classes
    LowPriorityDefaultReads
  95. implicit val uuidReads: Reads[UUID]

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

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

    Permalink
    Definition Classes
    ConstraintReads
  98. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. def zonedDateTimeReads[T](parsing: T, corrector: (String) ⇒ String = identity)(implicit p: (T) ⇒ TemporalParser[ZonedDateTime]): Reads[ZonedDateTime]

    Permalink

    Reads for the java.time.ZonedDateTime type.

    Reads for the java.time.ZonedDateTime type. When input value doesn't specify the time zone, then java.time.ZoneId.systemDefault is used.

    T

    Type of argument to instantiate date/time parser

    parsing

    Argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    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. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    DefaultReads
    See also

    TemporalFormatter

    import play.api.libs.json.Java8Reads.zonedDateTimeReads
    val customReads1 = zonedDateTimeReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = zonedDateTimeReads(DateTimeFormatter.ISO_DATE_TIME)
    val customReads3 = zonedDateTimeReads(
      DateTimeFormatter.ISO_DATE_TIME, _.drop(1))

Deprecated Value Members

  1. def uuidReader(checkUuuidValidity: Boolean = false): UUIDReader

    Permalink
    Definition Classes
    DefaultReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4.3) Use UUIDReader

Inherited from DefaultReads

Inherited from LowPriorityDefaultReads

Inherited from PathReads

Inherited from ConstraintReads

Inherited from AnyRef

Inherited from Any

Ungrouped