Trait

play.api.libs.json

DefaultReads

Related Doc: package json

Permalink

trait DefaultReads extends LowPriorityDefaultReads

Default deserializer type classes.

Source
Reads.scala
Linear Supertypes
Known Subclasses
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. 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
    EnvReads
  2. class UUIDReader extends Reads[UUID]

    Permalink

    Deserializer for java.util.UUID

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
    EnvReads
  5. implicit def ArrayReads[T](implicit arg0: Reads[T], arg1: ClassTag[T]): Reads[Array[T]]

    Permalink

    Deserializer for Array[T] types.

  6. implicit object BigIntReads extends Reads[BigInt]

    Permalink

    Deserializer for BigInt

  7. implicit object BigIntegerReads extends Reads[BigInteger]

    Permalink

    Deserializer for BigInteger

  8. implicit object BooleanReads extends Reads[Boolean]

    Permalink

    Deserializer for Boolean types.

  9. implicit object ByteReads extends Reads[Byte]

    Permalink

    Deserializer for Byte types.

  10. implicit val DefaultDateReads: Reads[Date]

    Permalink

    the default implicit java.util.Date reads

    the default implicit java.util.Date reads

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

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

    Permalink

    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

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

    java.time.Duration

  13. implicit val DefaultJavaPeriodReads: Reads[Period]

    Permalink

    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

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

    java.time.Period

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

    Permalink

    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
  17. implicit val DefaultOffsetDateTimeReads: Reads[OffsetDateTime]

    Permalink

    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
  18. implicit val DefaultSqlDateReads: Reads[Date]

    Permalink

    the default implicit SqlDate reads

    the default implicit SqlDate reads

    Definition Classes
    EnvReads
  19. 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
    EnvReads
  20. implicit object DoubleReads extends Reads[Double]

    Permalink

    Deserializer for Double types.

  21. implicit object FloatReads extends Reads[Float]

    Permalink

    Deserializer for Float types.

  22. implicit object IntReads extends Reads[Int]

    Permalink

    Deserializer for Int types.

  23. object IsoDateReads extends Reads[Date]

    Permalink

    ISO 8601 Reads

    ISO 8601 Reads

    Definition Classes
    EnvReads
  24. implicit object JsArrayReads extends Reads[JsArray]

    Permalink

    Deserializer for JsArray.

  25. implicit object JsBooleanReads extends Reads[JsBoolean]

    Permalink

    Deserializer for JsBoolean.

  26. 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) }

  27. implicit object JsNumberReads extends Reads[JsNumber]

    Permalink

    Deserializer for JsNumber.

  28. implicit object JsObjectReads extends Reads[JsObject]

    Permalink

    Deserializer for JsObject.

  29. implicit object JsStringReads extends Reads[JsString]

    Permalink

    Deserializer for JsString.

  30. implicit object JsValueReads extends Reads[JsValue]

    Permalink

    Deserializer for JsValue.

  31. implicit object JsonNodeReads extends Reads[JsonNode]

    Permalink

    Deserializer for Jackson JsonNode

    Deserializer for Jackson JsonNode

    Definition Classes
    EnvReads
  32. implicit object LongReads extends Reads[Long]

    Permalink

    Deserializer for Long types.

  33. implicit object ObjectNodeReads extends Reads[ObjectNode]

    Permalink

    Deserializer for Jackson ObjectNode

    Deserializer for Jackson ObjectNode

    Definition Classes
    EnvReads
  34. implicit object ShortReads extends Reads[Short]

    Permalink

    Deserializer for Short types.

  35. implicit object StringReads extends Reads[String]

    Permalink

    Deserializer for String types.

  36. object TemporalParser

    Permalink

    Parsing companion

    Parsing companion

    Definition Classes
    EnvReads
  37. implicit val ZoneIdReads: Reads[ZoneId]

    Permalink

    Reads for the java.time.ZoneId type.

    Reads for the java.time.ZoneId type.

    Definition Classes
    EnvReads
  38. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  39. implicit val bigDecReads: Reads[BigDecimal]

    Permalink

    Deserializer for BigDecimal

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

    Permalink

    Deserializer for a Map[Char, V]

  41. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. 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
    EnvReads
  43. def enumNameReads[E <: Enumeration](enum: E): Reads[enumNameReads.E.Value]

    Permalink

    Reads for scala.Enumeration types using the name.

    Reads for scala.Enumeration types using the name.

    enum

    a scala.Enumeration.

  44. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  49. 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.

    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 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))
  50. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Deserializer for BigDecimal

  52. val javaDurationMillisReads: Reads[Duration]

    Permalink

    Deserializer of Java Duration from a number of milliseconds.

    Deserializer of Java Duration from a number of milliseconds.

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

    Permalink

    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
  54. val javaPeriodDaysReads: Reads[Period]

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink

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

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

    Definition Classes
    EnvReads
  58. 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.

    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 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))
  59. 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.

    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 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))
  60. def localTimeReads[T](parsing: T, corrector: (String) ⇒ String = identity)(implicit p: (T) ⇒ TemporalParser[LocalTime]): Reads[LocalTime]

    Permalink

    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 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))
  61. val localeObjectReads: Reads[Locale]

    Permalink

    Deserializer for a Locale from an object representation

    Deserializer for a Locale from an object representation

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

    Permalink

    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
  63. implicit def mapReads[V](implicit fmtv: Reads[V]): Reads[Map[String, V]]

    Permalink

    Deserializer for a Map[String,V]

  64. implicit def mapReads[K, V](k: (String) ⇒ JsResult[K])(implicit fmtv: Reads[V]): Reads[Map[K, V]]

    Permalink

    Deserializer for a Map[K,V]

  65. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  68. def offsetDateTimeReads[T](parsing: T, corrector: (String) ⇒ String = identity)(implicit p: (T) ⇒ TemporalParser[OffsetDateTime]): Reads[OffsetDateTime]

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  72. 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
  73. implicit val uuidReads: Reads[UUID]

    Permalink
  74. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. 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.

    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 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))

Deprecated Value Members

  1. val DefaultJodaDateReads: Reads[DateTime]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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