Packages

t

play.api.libs.json

DefaultReads

trait DefaultReads extends LowPriorityDefaultReads

Default deserializer type classes.

Source
Reads.scala
Linear Supertypes
LowPriorityDefaultReads, EnvReads, AnyRef, Any
Known Subclasses
Reads
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultReads
  2. LowPriorityDefaultReads
  3. EnvReads
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class UUIDReader extends Reads[UUID]

    Deserializer for java.util.UUID

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

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

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

    Definition Classes
    EnvReads

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.

  5. implicit val DefaultDateReads: Reads[Date]

    the default implicit java.util.Date reads

    the default implicit java.util.Date reads

    Definition Classes
    EnvReads
  6. implicit val DefaultInstantReads: Reads[Instant]

    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:30Z', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

    Definition Classes
    EnvReads
  7. implicit val DefaultJavaDurationReads: Reads[Duration]

    Deserializer of Java Duration, from either a time-based amount of time (string representation such as '34.5 seconds'), or from a number of milliseconds (see javaDurationMillisReads).

    Deserializer of Java Duration, from either a time-based amount of time (string representation such as '34.5 seconds'), or from a number of milliseconds (see javaDurationMillisReads).

    Definition Classes
    EnvReads
    See also

    java.time.Duration

    DefaultJavaPeriodReads if you want to use java.time.Period instead.

  8. implicit val DefaultJavaPeriodReads: Reads[Period]

    Deserializer of Java Period, from either a time-based amount of time in the ISO-8601 calendar system, such as '2 years, 3 months and 4 days' or from a number of days (see javaPeriodDaysReads).

    Deserializer of Java Period, from either a time-based amount of time in the ISO-8601 calendar system, such as '2 years, 3 months and 4 days' or from a number of days (see javaPeriodDaysReads).

    Definition Classes
    EnvReads
    See also

    java.time.Period

    DefaultJavaDurationReads if you want to use java.time.Duration instead.

  9. implicit val DefaultLocalDateReads: Reads[LocalDate]

    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
    EnvReads
  10. implicit val DefaultLocalDateTimeReads: Reads[LocalDateTime]

    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
    EnvReads
  11. implicit val DefaultLocalTimeReads: Reads[LocalTime]

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

    The default typeclass to reads java.time.LocalTime from JSON. Accepts date formats as '10:15:30' (or '10:15').

    Definition Classes
    EnvReads
  12. implicit val DefaultOffsetDateTimeReads: Reads[OffsetDateTime]

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

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

    Definition Classes
    EnvReads
  13. implicit val DefaultSqlDateReads: Reads[Date]

    the default implicit SqlDate reads

    the default implicit SqlDate reads

    Definition Classes
    EnvReads
  14. implicit val DefaultZonedDateTimeReads: Reads[ZonedDateTime]

    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
    EnvReads
  15. 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) }

  16. implicit val ZoneIdReads: Reads[ZoneId]

    Reads for the java.time.ZoneId type.

    Reads for the java.time.ZoneId type.

    Definition Classes
    EnvReads
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. implicit val bigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

  19. def charMapReads[V](implicit vr: Reads[V]): Reads[Map[Char, V]]

    Deserializer for a Map[Char, V]

  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  21. 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
    EnvReads
  22. def enumNameReads[E <: Enumeration](enum: E): Reads[enumNameReads.E.Value]

    Reads for scala.Enumeration types using the name.

    Reads for scala.Enumeration types using the name.

    enum

    a scala.Enumeration.

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def instantReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => TemporalParser[Instant]): Reads[Instant]

    Reads for the java.time.Instant type.

    Reads for the java.time.Instant type.

    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
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter

import play.api.libs.json.Reads.instantReads

val customReads1 = instantReads("dd/MM/yyyy, HH:mm:ss")
val customReads2 = instantReads(DateTimeFormatter.ISO_INSTANT)
val customReads3 = instantReads(DateTimeFormatter.ISO_INSTANT, _.drop(1))
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. implicit val javaBigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

  31. val javaDurationMillisReads: Reads[Duration]

    Deserializer of Java Duration from a number of milliseconds.

    Deserializer of Java Duration from a number of milliseconds.

    Definition Classes
    EnvReads
  32. def javaDurationNumberReads(unit: TemporalUnit): Reads[Duration]

    Deserializer of Java Duration from an integer (long) number, using the specified temporal unit.

    Deserializer of Java Duration from an integer (long) number, using the specified temporal unit.

    Definition Classes
    EnvReads
  33. val javaPeriodDaysReads: Reads[Period]

    Deserializer of Java Period from a number (integer) of days.

    Deserializer of Java Period from a number (integer) of days.

    Definition Classes
    EnvReads
  34. val javaPeriodMonthsReads: Reads[Period]

    Deserializer of Java Period from a number (integer) of months.

    Deserializer of Java Period from a number (integer) of months.

    Definition Classes
    EnvReads
  35. val javaPeriodWeeksReads: Reads[Period]

    Deserializer of Java Period from a number (integer) of weeks.

    Deserializer of Java Period from a number (integer) of weeks.

    Definition Classes
    EnvReads
  36. val javaPeriodYearsReads: Reads[Period]

    Deserializer of Java Period from a number (integer) of years.

    Deserializer of Java Period from a number (integer) of years.

    Definition Classes
    EnvReads
  37. implicit def keyMapReads[K, V](implicit arg0: KeyReads[K], fmtv: Reads[V]): Reads[Map[K, V]]
    Definition Classes
    LowPriorityDefaultReads
  38. def localDateReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => TemporalParser[LocalDate]): Reads[LocalDate]

    Reads for the java.time.LocalDate type.

    Reads for the java.time.LocalDate type.

    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
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter

import play.api.libs.json.Reads.localDateReads

val customReads1 = localDateReads("dd/MM/yyyy, HH:mm:ss")
val customReads2 = localDateReads(DateTimeFormatter.ISO_DATE)
val customReads3 = localDateReads(DateTimeFormatter.ISO_DATE, _.drop(1))
  39. def localDateTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => TemporalParser[LocalDateTime]): Reads[LocalDateTime]

    Reads for the java.time.LocalDateTime type.

    Reads for the java.time.LocalDateTime type.

    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
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter

import play.api.libs.json.Reads.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))
  40. def localTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => TemporalParser[LocalTime]): Reads[LocalTime]

    Reads for the java.time.LocalTime type.

    Reads for the java.time.LocalTime type.

    T

    Type of argument to instantiate time parser

    parsing

    Argument to instantiate 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
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter

import play.api.libs.json.Reads.localTimeReads

val customReads1 = localTimeReads("dd/MM/yyyy, HH:mm:ss")
val customReads2 = localTimeReads(DateTimeFormatter.ISO_TIME)
val customReads3 = localTimeReads(DateTimeFormatter.ISO_TIME, _.drop(1))
  41. val localeObjectReads: Reads[Locale]

    Deserializer for a Locale from an object representation

    Deserializer for a Locale from an object representation

    Definition Classes
    EnvReads
  42. implicit val localeReads: Reads[Locale]

    Deserializer for a Locale from a IETF BCP 47 string representation

    Deserializer for a Locale from a IETF BCP 47 string representation

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

    Deserializer for a Map[String,V]

  44. implicit def mapReads[K, V](k: (String) => JsResult[K])(implicit fmtv: Reads[V]): Reads[Map[K, V]]

    Deserializer for a Map[K,V]

  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. def offsetDateTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => TemporalParser[OffsetDateTime]): Reads[OffsetDateTime]

    Reads for the java.time.OffsetDateTime type.

    Reads for the java.time.OffsetDateTime type.

    Note: it is intentionally not supported to read an OffsetDateTime from a number.

    T

    the type of argument to instantiate date/time parser

    parsing

    The 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

    the implicit conversion based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter

import play.api.libs.json.Reads.offsetDateTimeReads

val customReads1 = offsetDateTimeReads("dd/MM/yyyy, HH:mm:ss (Z)")
val customReads2 = offsetDateTimeReads(DateTimeFormatter.ISO_OFFSET_DATE_TIME)
val customReads3 = offsetDateTimeReads(
  DateTimeFormatter.ISO_OFFSET_DATE_TIME, _.drop(1))
  49. 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
    EnvReads
  50. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. implicit def traversableReads[F[_], A](implicit bf: Factory[A, F[A]], ra: Reads[A]): Reads[F[A]]

    Generic deserializer for collections types.

    Generic deserializer for collections types.

    Definition Classes
    LowPriorityDefaultReads
  53. implicit val uriReads: Reads[URI]

    Deserializer for java.net.URI

  54. implicit val uuidReads: Reads[UUID]
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  58. def zonedDateTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => TemporalParser[ZonedDateTime]): Reads[ZonedDateTime]

    Reads for the java.time.ZonedDateTime type.

    Reads for the java.time.ZonedDateTime type.

    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
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter

import play.api.libs.json.Reads.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))
  59. implicit object BigIntReads extends Reads[BigInt]

    Deserializer for BigInt

  60. implicit object BigIntegerReads extends Reads[BigInteger]

    Deserializer for BigInteger

  61. implicit object BooleanReads extends Reads[Boolean]

    Deserializer for Boolean types.

  62. implicit object ByteReads extends Reads[Byte]

    Deserializer for Byte types.

  63. implicit object DoubleReads extends Reads[Double]

    Deserializer for Double types.

  64. implicit object FloatReads extends Reads[Float]

    Deserializer for Float types.

  65. implicit object IntReads extends Reads[Int]

    Deserializer for Int types.

  66. implicit object JsArrayReads extends Reads[JsArray]

    Deserializer for JsArray.

  67. implicit object JsBooleanReads extends Reads[JsBoolean]

    Deserializer for JsBoolean.

  68. implicit object JsNumberReads extends Reads[JsNumber]

    Deserializer for JsNumber.

  69. implicit object JsObjectReads extends Reads[JsObject]

    Deserializer for JsObject.

  70. implicit object JsStringReads extends Reads[JsString]

    Deserializer for JsString.

  71. implicit object JsValueReads extends Reads[JsValue]

    Deserializer for JsValue.

  72. implicit object LongReads extends Reads[Long]

    Deserializer for Long types.

  73. implicit object ShortReads extends Reads[Short]

    Deserializer for Short types.

  74. implicit object StringReads extends Reads[String]

    Deserializer for String types.

  75. implicit object ArrayNodeReads extends Reads[ArrayNode]

    Deserializer for Jackson ArrayNode

    Deserializer for Jackson ArrayNode

    Definition Classes
    EnvReads
  76. object IsoDateReads extends Reads[Date]

    ISO 8601 Reads

    ISO 8601 Reads

    Definition Classes
    EnvReads
  77. implicit object JsonNodeReads extends Reads[JsonNode]

    Deserializer for Jackson JsonNode

    Deserializer for Jackson JsonNode

    Definition Classes
    EnvReads
  78. implicit object ObjectNodeReads extends Reads[ObjectNode]

    Deserializer for Jackson ObjectNode

    Deserializer for Jackson ObjectNode

    Definition Classes
    EnvReads
  79. object TemporalParser

    Parsing companion

    Parsing companion

    Definition Classes
    EnvReads

Deprecated Value Members

  1. val DefaultJodaDateReads: Reads[DateTime]
    Definition Classes
    EnvReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Include play-json-joda as a dependency and use JodaReads.DefaultJodaDateTimeReads

  2. val DefaultJodaLocalDateReads: Reads[LocalDate]
    Definition Classes
    EnvReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Include play-json-joda as a dependency and use JodaReads.DefaultJodaLocalDateReads

  3. val DefaultJodaLocalTimeReads: Reads[LocalTime]
    Definition Classes
    EnvReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Include play-json-joda as a dependency and use JodaReads.DefaultJodaLocalTimeReads

  4. def jodaDateReads(pattern: String, corrector: (String) => String = identity): Reads[DateTime]
    Definition Classes
    EnvReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Include play-json-joda as a dependency and use JodaReads.jodaDateReads

  5. def jodaLocalDateReads(pattern: String, corrector: (String) => String = identity): Reads[LocalDate]
    Definition Classes
    EnvReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Include play-json-joda as a dependency and use JodaReads.jodaLocalDateReads

  6. def jodaLocalTimeReads(pattern: String, corrector: (String) => String = identity): Reads[LocalTime]
    Definition Classes
    EnvReads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Include play-json-joda as a dependency and use JodaReads.jodaLocalTimeReads

Inherited from LowPriorityDefaultReads

Inherited from EnvReads

Inherited from AnyRef

Inherited from Any

Ungrouped