play.api.libs.json

Reads

object Reads extends ConstraintReads with PathReads with DefaultReads

Default deserializer type classes.

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

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

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

    the default implicit JodaDate reads

    the default implicit JodaDate reads

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

    the default implicit joda.

    the default implicit joda.time.LocalDate reads

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

    the default implicit joda.

    the default implicit joda.time.LocalTime reads

    Definition Classes
    DefaultReads
  15. 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
    DefaultReads
  16. 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
    DefaultReads
  17. implicit val DefaultSqlDateReads: Reads[Date]

    the default implicit JodaDate reads

    the default implicit JodaDate reads

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

    Deserializer for Double types.

  20. implicit object FloatReads extends Reads[Float]

    Deserializer for Float types.

  21. implicit object IntReads extends Reads[Int]

    Deserializer for Int types.

  22. object IsoDateReads extends Reads[Date]

    ISO 8601 Reads

  23. implicit object JsArrayMonoid extends Monoid[JsArray]

  24. implicit object JsArrayReads extends Reads[JsArray]

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

  26. implicit object JsBooleanReads extends Reads[JsBoolean]

    Definition Classes
    DefaultReads
  27. 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
  28. implicit object JsNumberReads extends Reads[JsNumber]

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

  30. implicit object JsObjectReads extends Reads[JsObject]

    Deserializer for JsObject.

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

  32. implicit object JsStringReads extends Reads[JsString]

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

    Deserializer for JsValue.

  34. implicit object JsonNodeReads extends Reads[JsonNode]

    Deserializer for Jackson JsonNode

  35. implicit object LongReads extends Reads[Long]

    Deserializer for Long types.

  36. implicit object ObjectNodeReads extends Reads[ObjectNode]

    Deserializer for Jackson ObjectNode

  37. implicit object ShortReads extends Reads[Short]

    Deserializer for Short types.

  38. implicit object StringReads extends Reads[String]

    Deserializer for String types.

  39. object TemporalParser

    Parsing companion

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

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

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

  43. final def asInstanceOf[T0]: T0

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

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

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  46. def clone(): AnyRef

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

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

    Reads for the java.util.Date type.

    Reads for the java.util.Date type.

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    DefaultReads
  49. def email(implicit reads: Reads[String]): Reads[String]

    Definition Classes
    ConstraintReads
  50. 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
  51. final def eq(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    ConstraintReads
  55. def finalize(): Unit

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

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

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

    Definition Classes
    AnyRef → Any
  59. 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. 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))
  60. final def isInstanceOf[T0]: Boolean

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

    Deserializer for BigDecimal

    Deserializer for BigDecimal

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

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

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

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    DefaultReads
  63. def jodaLocalDateReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[LocalDate]

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

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

    pattern

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

    corrector

    string transformation function (See jodaDateReads)

    Definition Classes
    DefaultReads
  64. def jodaLocalTimeReads(pattern: String, corrector: (String) ⇒ String = identity): Reads[LocalTime]

    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
  65. def jsCopyTo[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

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

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

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

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

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

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

    Definition Classes
    ConstraintReads
  72. 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. 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))
  73. 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. 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))
  74. def map[A](implicit reads: Reads[A]): Reads[Map[String, A]]

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

    Deserializer for Map[String,V] types.

    Deserializer for Map[String,V] types.

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

    Defines a maximum value for a numeric Reads.

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

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

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

    Defines a minimum value for a numeric Reads.

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

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

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

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

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

    Definition Classes
    AnyRef
  83. 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
  84. 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
  85. 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
  86. 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
  87. val path: PathReads

  88. 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
  89. def pure[A](a: ⇒ A): Reads[A]

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

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

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

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

    Reads for the java.sql.Date type.

    Reads for the java.sql.Date type.

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    DefaultReads
  94. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  95. def toString(): String

    Definition Classes
    AnyRef → Any
  96. 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
  97. def uuidReader(checkUuuidValidity: Boolean = false): Reads[UUID]

    Deserializer for java.

    Deserializer for java.util.UUID

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

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

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

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

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

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

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

Inherited from DefaultReads

Inherited from LowPriorityDefaultReads

Inherited from PathReads

Inherited from ConstraintReads

Inherited from AnyRef

Inherited from Any

Ungrouped