Default deserializer type classes.
- Companion
- class
Type members
Classlikes
Inherited classlikes
Deserializer for Jackson ArrayNode
Deserializer for Jackson ArrayNode
- Inherited from
- EnvReads
Deserializer for BigInteger
Deserializer for BigInteger
- Inherited from
- DefaultReads
Deserializer for Boolean types.
Deserializer for Boolean types.
- Inherited from
- DefaultReads
Deserializer for Byte types.
Deserializer for Byte types.
- Inherited from
- DefaultReads
Deserializer for Double types.
Deserializer for Double types.
- Inherited from
- DefaultReads
Deserializer for Float types.
Deserializer for Float types.
- Inherited from
- DefaultReads
Deserializer for JsBoolean.
Deserializer for JsBoolean.
- Inherited from
- DefaultReads
Deserializer for JsNumber.
Deserializer for JsNumber.
- Inherited from
- DefaultReads
Deserializer for JsObject.
Deserializer for JsObject.
- Inherited from
- DefaultReads
Deserializer for JsString.
Deserializer for JsString.
- Inherited from
- DefaultReads
Deserializer for Jackson JsonNode
Deserializer for Jackson JsonNode
- Inherited from
- EnvReads
Deserializer for Long types.
Deserializer for Long types.
- Inherited from
- DefaultReads
Deserializer for Jackson ObjectNode
Deserializer for Jackson ObjectNode
- Inherited from
- EnvReads
Deserializer for Short types.
Deserializer for Short types.
- Inherited from
- DefaultReads
Deserializer for String types.
Deserializer for String types.
- Inherited from
- DefaultReads
Typeclass to implement way of parsing string as Java8 temporal types.
Typeclass to implement way of parsing string as Java8 temporal types.
- Inherited from
- EnvReads
Value members
Concrete methods
Returns an instance which uses f
as Reads.reads function.
Returns an instance which uses f
as Reads.reads function.
Returns a JsError(cause)
for any JSON value read.
Returns a JsError(cause)
for any JSON value read.
import play.api.libs.json.Reads
val r: Reads[String] = Reads.failed[String]("Failure message")
- See also
pure
Inherited methods
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) }
- Inherited from
- DefaultReads
Reads for the java.util.Date
type.
Reads for the java.util.Date
type.
- Value Params
- 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
- pattern
a date pattern, as specified in
java.text.SimpleDateFormat
.
- Inherited from
- EnvReads
Reads for scala.Enumeration
types using the name.
Reads for scala.Enumeration
types using the name.
- Value Params
- enum
a
scala.Enumeration
.
- Inherited from
- DefaultReads
Reads for the java.time.Instant
type.
Reads for the java.time.Instant
type.
- Type Params
- T
Type of argument to instantiate date parser
- Value Params
- 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
- parsing
Argument to instantiate date parser. Actually either a pattern (string) or a formatter (
java.time.format.DateTimeFormatter
)
- 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))
- Inherited from
- EnvReads
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.
- Inherited from
- EnvReads
Reads for the java.time.LocalDate
type.
Reads for the java.time.LocalDate
type.
- Type Params
- T
Type of argument to instantiate date parser
- Value Params
- 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
- parsing
Argument to instantiate date parser. Actually either a pattern (string) or a formatter (
java.time.format.DateTimeFormatter
)
- 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))
- Inherited from
- EnvReads
Reads for the java.time.LocalDateTime
type.
Reads for the java.time.LocalDateTime
type.
- Type Params
- T
Type of argument to instantiate date/time parser
- Value Params
- 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
- parsing
Argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (
java.time.format.DateTimeFormatter
)
- 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))
- Inherited from
- EnvReads
Reads for the java.time.LocalTime
type.
Reads for the java.time.LocalTime
type.
- Type Params
- T
Type of argument to instantiate time parser
- Value Params
- 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
- parsing
Argument to instantiate time parser. Actually either a pattern (string) or a formatter (
java.time.format.DateTimeFormatter
)
- 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))
- Inherited from
- EnvReads
Defines a maximum value for a Reads. Combine with min
using andKeep
, e.g.
.read(Reads.min(0.1) andKeep Reads.max(1.0))
.
Defines a maximum value for a Reads. Combine with min
using andKeep
, e.g.
.read(Reads.min(0.1) andKeep Reads.max(1.0))
.
- Inherited from
- ConstraintReads
Defines a minimum value for a Reads. Combine with max
using andKeep
, e.g.
.read(Reads.min(0) andKeep Reads.max(100))
.
Defines a minimum value for a Reads. Combine with max
using andKeep
, e.g.
.read(Reads.min(0) andKeep Reads.max(100))
.
- Inherited from
- ConstraintReads
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:
- If any node in JsPath is not found => returns None
- If any node in JsPath is found with value "null" => returns None
- If the entire path is found => applies implicit Reads[T]
- Inherited from
- PathReads
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:
- If any node in JsPath is not found => returns default value
- If the last node in JsPath is found with value "null" => returns None
- If the entire path is found => applies implicit Reads[T]
- Inherited from
- PathReads
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
- Inherited from
- ConstraintReads
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.
- Type Params
- T
the type of argument to instantiate date/time parser
- Value Params
- 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
- parsing
The argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (
java.time.format.DateTimeFormatter
)
- 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))
- Inherited from
- EnvReads
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
- Inherited from
- ConstraintReads
very simple optional field Reads that maps "null" to None
very simple optional field Reads that maps "null" to None
- Inherited from
- ConstraintReads
Defines a regular expression constraint for String
values, i.e. the string must match the regular expression pattern
Defines a regular expression constraint for String
values, i.e. the string must match the regular expression pattern
- Inherited from
- ConstraintReads
Reads for the java.sql.Date
type.
Reads for the java.sql.Date
type.
- Value Params
- 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
- pattern
a date pattern, as specified in
java.text.SimpleDateFormat
.
- Inherited from
- EnvReads
Reads for the java.time.ZonedDateTime
type.
Reads for the java.time.ZonedDateTime
type.
- Type Params
- T
Type of argument to instantiate date/time parser
- Value Params
- 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
- parsing
Argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (
java.time.format.DateTimeFormatter
)
- 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))
- Inherited from
- EnvReads
Inherited fields
Deserializer of Java Duration from a number of milliseconds.
Deserializer of Java Duration from a number of milliseconds.
- Inherited from
- EnvReads
Deserializer of Java Period from a number (integer) of days.
Deserializer of Java Period from a number (integer) of days.
- Inherited from
- EnvReads
Deserializer of Java Period from a number (integer) of months.
Deserializer of Java Period from a number (integer) of months.
- Inherited from
- EnvReads
Deserializer of Java Period from a number (integer) of weeks.
Deserializer of Java Period from a number (integer) of weeks.
- Inherited from
- EnvReads
Deserializer of Java Period from a number (integer) of years.
Deserializer of Java Period from a number (integer) of years.
- Inherited from
- EnvReads
Deserializer for a Locale
from an object representation
Deserializer for a Locale
from an object representation
- Inherited from
- EnvReads
Implicits
Implicits
Inherited implicits
the default implicit java.util.Date reads
the default implicit java.util.Date reads
- Inherited from
- EnvReads
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]'.
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]'.
- Inherited from
- EnvReads
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).
- See also
java.time.Duration
DefaultJavaPeriodReads if you want to use java.time.Period instead.
- Inherited from
- EnvReads
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).
- See also
java.time.Period
DefaultJavaDurationReads if you want to use java.time.Duration instead.
- Inherited from
- EnvReads
The default typeclass to reads java.time.LocalDate
from JSON.
Accepts date formats as '2011-12-03'.
The default typeclass to reads java.time.LocalDate
from JSON.
Accepts date formats as '2011-12-03'.
- Inherited from
- EnvReads
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]'.
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]'.
- Inherited from
- EnvReads
The default typeclass to reads java.time.LocalTime
from JSON.
Accepts date formats as '10:15:30' (or '10:15').
The default typeclass to reads java.time.LocalTime
from JSON.
Accepts date formats as '10:15:30' (or '10:15').
- Inherited from
- EnvReads
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]'.
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]'.
- Inherited from
- EnvReads
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]'.
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]'.
- Inherited from
- EnvReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
- Inherited from
- GeneratedReads
Deserializer for a Locale
from a IETF BCP 47 string representation
Deserializer for a Locale
from a IETF BCP 47 string representation
- Inherited from
- EnvReads
Generic deserializer for collections types.
Generic deserializer for collections types.
- Inherited from
- LowPriorityDefaultReads