play.api.libs.json

Reads

object Reads extends ConstraintReads with PathReads with DefaultReads with GeneratedReads

Default deserializer type classes.

Linear Supertypes
GeneratedReads, DefaultReads, LowPriorityDefaultReads, EnvReads, PathReads, ConstraintReads, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Reads
  2. GeneratedReads
  3. DefaultReads
  4. LowPriorityDefaultReads
  5. EnvReads
  6. PathReads
  7. ConstraintReads
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

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

  2. class UUIDReader extends Reads[UUID]

    Deserializer for java.

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

    Deserializer for Jackson ArrayNode

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

  8. implicit object BooleanReads extends Reads[Boolean]

    Deserializer for Boolean types.

  9. implicit object ByteReads extends Reads[Byte]

    Deserializer for Byte types.

  10. implicit val DefaultDateReads: Reads[Date]

    the default implicit java.

    the default implicit java.util.Date reads

    Definition Classes
    EnvReads

  11. 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

  12. implicit val DefaultJavaDurationReads: Reads[Duration]

    Deserializer of Java Duration, from either a time-based amount of time (string representation such as '34.

    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]

    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]

    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]

    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]

    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]

    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]

    the default implicit SqlDate reads

    the default implicit SqlDate reads

    Definition Classes
    EnvReads

  19. 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

  20. implicit object DoubleReads extends Reads[Double]

    Deserializer for Double types.

  21. implicit object FloatReads extends Reads[Float]

    Deserializer for Float types.

  22. implicit object IntReads extends Reads[Int]

    Deserializer for Int types.

  23. object IsoDateReads extends Reads[Date]

    ISO 8601 Reads

  24. implicit object JsArrayMonoid extends Monoid[JsArray]

  25. implicit object JsArrayReads extends Reads[JsArray]

    Deserializer for JsArray.

  26. implicit val JsArrayReducer: Reducer[JsValue, JsArray]

  27. implicit object JsBooleanReads extends Reads[JsBoolean]

    Deserializer for JsBoolean.

  28. 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

  29. implicit object JsNumberReads extends Reads[JsNumber]

    Deserializer for JsNumber.

  30. implicit object JsObjectMonoid extends Monoid[JsObject]

  31. implicit object JsObjectReads extends Reads[JsObject]

    Deserializer for JsObject.

  32. implicit val JsObjectReducer: Reducer[JsObject, JsObject]

  33. implicit object JsStringReads extends Reads[JsString]

    Deserializer for JsString.

  34. implicit object JsValueReads extends Reads[JsValue]

    Deserializer for JsValue.

  35. implicit object JsonNodeReads extends Reads[JsonNode]

    Deserializer for Jackson JsonNode

  36. implicit object LongReads extends Reads[Long]

    Deserializer for Long types.

  37. implicit object ObjectNodeReads extends Reads[ObjectNode]

    Deserializer for Jackson ObjectNode

  38. implicit object ShortReads extends Reads[Short]

    Deserializer for Short types.

  39. implicit object StringReads extends Reads[String]

    Deserializer for String types.

  40. object TemporalParser

    Parsing companion

  41. implicit def Tuple10R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)]

    Definition Classes
    GeneratedReads

  42. implicit def Tuple11R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)]

    Definition Classes
    GeneratedReads

  43. implicit def Tuple12R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)]

    Definition Classes
    GeneratedReads

  44. implicit def Tuple13R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)]

    Definition Classes
    GeneratedReads

  45. implicit def Tuple14R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)]

    Definition Classes
    GeneratedReads

  46. implicit def Tuple15R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)]

    Definition Classes
    GeneratedReads

  47. implicit def Tuple16R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)]

    Definition Classes
    GeneratedReads

  48. implicit def Tuple17R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)]

    Definition Classes
    GeneratedReads

  49. implicit def Tuple18R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)]

    Definition Classes
    GeneratedReads

  50. implicit def Tuple19R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)]

    Definition Classes
    GeneratedReads

  51. implicit def Tuple1R[T1](implicit arg0: Reads[T1]): Reads[(T1)]

    Definition Classes
    GeneratedReads

  52. implicit def Tuple20R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19], arg19: Reads[T20]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)]

    Definition Classes
    GeneratedReads

  53. implicit def Tuple21R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19], arg19: Reads[T20], arg20: Reads[T21]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)]

    Definition Classes
    GeneratedReads

  54. implicit def Tuple22R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19], arg19: Reads[T20], arg20: Reads[T21], arg21: Reads[T22]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]

    Definition Classes
    GeneratedReads

  55. implicit def Tuple2R[T1, T2](implicit arg0: Reads[T1], arg1: Reads[T2]): Reads[(T1, T2)]

    Definition Classes
    GeneratedReads

  56. implicit def Tuple3R[T1, T2, T3](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3]): Reads[(T1, T2, T3)]

    Definition Classes
    GeneratedReads

  57. implicit def Tuple4R[T1, T2, T3, T4](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4]): Reads[(T1, T2, T3, T4)]

    Definition Classes
    GeneratedReads

  58. implicit def Tuple5R[T1, T2, T3, T4, T5](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5]): Reads[(T1, T2, T3, T4, T5)]

    Definition Classes
    GeneratedReads

  59. implicit def Tuple6R[T1, T2, T3, T4, T5, T6](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6]): Reads[(T1, T2, T3, T4, T5, T6)]

    Definition Classes
    GeneratedReads

  60. implicit def Tuple7R[T1, T2, T3, T4, T5, T6, T7](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7]): Reads[(T1, T2, T3, T4, T5, T6, T7)]

    Definition Classes
    GeneratedReads

  61. implicit def Tuple8R[T1, T2, T3, T4, T5, T6, T7, T8](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8)]

    Definition Classes
    GeneratedReads

  62. implicit def Tuple9R[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]

    Definition Classes
    GeneratedReads

  63. implicit val ZoneIdReads: Reads[ZoneId]

    Reads for the java.time.ZoneId type.

    Reads for the java.time.ZoneId type.

    Definition Classes
    EnvReads

  64. implicit def alternative(implicit a: Applicative[Reads]): Alternative[Reads]

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

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

  67. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  68. def at[A](path: JsPath)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads

  69. implicit val bigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads

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

    Deserializer for a Map[Char, V]

    Deserializer for a Map[Char, V]

    Definition Classes
    DefaultReads

  71. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  72. val constraints: ConstraintReads

  73. 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

  74. def email(implicit reads: Reads[String]): Reads[String]

    Definition Classes
    ConstraintReads

  75. def enumNameReads[E <: Enumeration](enum: E): Reads[DefaultReads.enumNameReads.E.Value]

    Reads for scala.Enumeration types using the name.

    Reads for scala.Enumeration types using the name.

    enum

    a scala.Enumeration.

    Definition Classes
    DefaultReads

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

    Definition Classes
    AnyRef

  77. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  78. def filter[A](otherwise: JsonValidationError)(p: (A) ⇒ Boolean)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads

  79. def filterNot[A](error: JsonValidationError)(p: (A) ⇒ Boolean)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads

  80. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  81. implicit def functorReads(implicit a: Applicative[Reads]): Functor[Reads]

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

    Definition Classes
    AnyRef → Any

  83. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

  85. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  86. implicit val javaBigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads

  87. 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

  88. 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

  89. 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

  90. 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

  91. 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

  92. 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

  93. def jsCopyTo[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads

  94. def jsPick[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads

  95. def jsPickBranch[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads

  96. def jsPrune(path: JsPath): Reads[JsObject]

    Definition Classes
    PathReads

  97. def jsPut(path: JsPath, a: ⇒ JsValue): Reads[JsObject]

    Definition Classes
    PathReads

  98. def jsUpdate[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads

  99. def list[A](implicit reads: Reads[A]): Reads[List[A]]

    Definition Classes
    ConstraintReads

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

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

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

  103. val localeObjectReads: Reads[Locale]

    Deserializer for a Locale from an object representation

    Deserializer for a Locale from an object representation

    Definition Classes
    EnvReads

  104. 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

  105. def map[A](implicit reads: Reads[A]): Reads[Map[String, A]]

    Definition Classes
    ConstraintReads

  106. implicit def mapReads[V](implicit fmtv: Reads[V]): Reads[Map[String, V]]

    Deserializer for a Map[String,V]

    Deserializer for a Map[String,V]

    Definition Classes
    DefaultReads

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

    Deserializer for a Map[K,V]

    Deserializer for a Map[K,V]

    Definition Classes
    DefaultReads

  108. def max[O](m: O)(implicit reads: Reads[O], ord: Ordering[O]): Reads[O]

    Defines a maximum value for a Reads.

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

    Definition Classes
    ConstraintReads

  109. def maxLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

    Definition Classes
    ConstraintReads

  110. def min[O](m: O)(implicit reads: Reads[O], ord: Ordering[O]): Reads[O]

    Defines a minimum value for a Reads.

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

    Definition Classes
    ConstraintReads

  111. def minLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

    Definition Classes
    ConstraintReads

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

    Definition Classes
    AnyRef

  113. final def notify(): Unit

    Definition Classes
    AnyRef

  114. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  115. 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

  116. def nullableWithDefault[A](path: JsPath, defaultValue: ⇒ Option[A])(implicit reads: Reads[A]): Reads[Option[A]]

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

    Reads a Option[T] search nullable field at JsPath (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 JsError( "missing-path" )
    • If last node is found with value "null" => returns None
    • If last node is found => applies implicit Reads[T]
    Definition Classes
    PathReads

  117. 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

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

  119. 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

  120. 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

  121. val path: PathReads

  122. 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

  123. def pure[A](a: A): Reads[A]

    Returns a JsSuccess(a) (with root path) for any JSON value read.

  124. def pure[A](a: ⇒ A): Reads[A]

    Definition Classes
    ConstraintReads

  125. def required(path: JsPath)(implicit reads: Reads[JsValue]): Reads[JsValue]

    Definition Classes
    PathReads

  126. def seq[A](implicit reads: Reads[A]): Reads[Seq[A]]

    Definition Classes
    ConstraintReads

  127. def set[A](implicit reads: Reads[A]): Reads[Set[A]]

    Definition Classes
    ConstraintReads

  128. 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

  129. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  130. def toString(): String

    Definition Classes
    AnyRef → Any

  131. 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
    LowPriorityDefaultReads

  132. implicit val uuidReads: Reads[UUID]

    Definition Classes
    DefaultReads

  133. def verifying[A](cond: (A) ⇒ Boolean)(implicit rds: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads

  134. def verifyingIf[A](cond: (A) ⇒ Boolean)(subreads: Reads[_])(implicit rds: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads

  135. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  136. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  137. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  138. def withDefault[A](path: JsPath, defaultValue: ⇒ A)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads

  139. 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 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]

    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 GeneratedReads

Inherited from DefaultReads

Inherited from LowPriorityDefaultReads

Inherited from EnvReads

Inherited from PathReads

Inherited from ConstraintReads

Inherited from AnyRef

Inherited from Any

Ungrouped