play-json/play.api.libs.json/DefaultReads

DefaultReads

trait DefaultReads extends LowPriorityDefaultReads

Default deserializer type classes.

trait EnvReads
class Object
trait Matchable
class Any
object Reads

Type members

Classlikes

object BigIntReads extends Reads[BigInt]

Deserializer for BigInt

Deserializer for BigInt

object BigIntegerReads extends Reads[BigInteger]

Deserializer for BigInteger

Deserializer for BigInteger

object BooleanReads extends Reads[Boolean]

Deserializer for Boolean types.

Deserializer for Boolean types.

object ByteReads extends Reads[Byte]

Deserializer for Byte types.

Deserializer for Byte types.

object DoubleReads extends Reads[Double]

Deserializer for Double types.

Deserializer for Double types.

object FloatReads extends Reads[Float]

Deserializer for Float types.

Deserializer for Float types.

object IntReads extends Reads[Int]

Deserializer for Int types.

Deserializer for Int types.

object JsArrayReads extends Reads[JsArray]

Deserializer for JsArray.

Deserializer for JsArray.

object JsBooleanReads extends Reads[JsBoolean]

Deserializer for JsBoolean.

Deserializer for JsBoolean.

object JsNumberReads extends Reads[JsNumber]

Deserializer for JsNumber.

Deserializer for JsNumber.

object JsObjectReads extends Reads[JsObject]

Deserializer for JsObject.

Deserializer for JsObject.

object JsStringReads extends Reads[JsString]

Deserializer for JsString.

Deserializer for JsString.

object JsValueReads extends Reads[JsValue]

Deserializer for JsValue.

Deserializer for JsValue.

object LongReads extends Reads[Long]

Deserializer for Long types.

Deserializer for Long types.

object ShortReads extends Reads[Short]

Deserializer for Short types.

Deserializer for Short types.

object StringReads extends Reads[String]

Deserializer for String types.

Deserializer for String types.

class UUIDReader(checkValidity: Boolean) extends Reads[UUID]

Deserializer for java.util.UUID

Deserializer for java.util.UUID

Inherited classlikes

object ArrayNodeReads

Deserializer for Jackson ArrayNode

Deserializer for Jackson ArrayNode

Inherited from
EnvReads
object IsoDateReads

ISO 8601 Reads

ISO 8601 Reads

Inherited from
EnvReads
object JsonNodeReads

Deserializer for Jackson JsonNode

Deserializer for Jackson JsonNode

Inherited from
EnvReads
object ObjectNodeReads

Deserializer for Jackson ObjectNode

Deserializer for Jackson ObjectNode

Inherited from
EnvReads
trait TemporalParser[T <: Temporal]

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
object TemporalParser

Parsing companion

Parsing companion

Inherited from
EnvReads

Value members

Concrete methods

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

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

Deserializer for a Map[Char, V]

Deserializer for a Map[Char, V]

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

Reads for scala.Enumeration types using the name.

Reads for scala.Enumeration types using the name.

Value Params
enum

a scala.Enumeration.

Inherited methods

def dateReads(pattern: String, corrector: String => String): Reads[Date]

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
def instantReads[T](parsing: T, corrector: String => String)(implicit p: T => TemporalParser[Instant]): Reads[Instant]

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

Inherited from
EnvReads
def localDateReads[T](parsing: T, corrector: String => String)(implicit p: T => TemporalParser[LocalDate]): Reads[LocalDate]

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
def localDateTimeReads[T](parsing: T, corrector: String => String)(implicit p: T => TemporalParser[LocalDateTime]): Reads[LocalDateTime]

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

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
def offsetDateTimeReads[T](parsing: T, corrector: String => String)(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.

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
protected def parseBigDecimal(input: String): JsResult[BigDecimal]
Inherited from
EnvReads
protected def parseBigInteger(input: String): JsResult[BigInteger]
Inherited from
EnvReads
def sqlDateReads(pattern: String, corrector: String => String): Reads[Date]

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
def zonedDateTimeReads[T](parsing: T, corrector: String => String)(implicit p: T => TemporalParser[ZonedDateTime]): Reads[ZonedDateTime]

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

val javaDurationMillisReads: Reads[Duration]

Deserializer of Java Duration from a number of milliseconds.

Deserializer of Java Duration from a number of milliseconds.

Inherited from
EnvReads
val javaPeriodDaysReads: Reads[Period]

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

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

Inherited from
EnvReads
val javaPeriodMonthsReads: Reads[Period]

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

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

Inherited from
EnvReads
val javaPeriodWeeksReads: Reads[Period]

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

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

Inherited from
EnvReads
val javaPeriodYearsReads: Reads[Period]

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

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

Inherited from
EnvReads
val localeObjectReads: Reads[Locale]

Deserializer for a Locale from an object representation

Deserializer for a Locale from an object representation

Inherited from
EnvReads

Implicits

Implicits

implicit def ArrayReads[T](implicit evidence$1: Reads[T], evidence$2: ClassTag[T]): Reads[Array[T]]

Deserializer for Array[T] types.

Deserializer for Array[T] types.

implicit val bigDecReads: Reads[BigDecimal]

Deserializer for BigDecimal

Deserializer for BigDecimal

implicit val javaBigDecReads: Reads[BigDecimal]

Deserializer for BigDecimal

Deserializer for BigDecimal

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]

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

Deserializer for a Map[String,V]

Deserializer for a Map[String,V]

implicit val uriReads: Reads[URI]

Deserializer for java.net.URI

Deserializer for java.net.URI

implicit val uuidReads: Reads[UUID]

Inherited implicits

implicit val DefaultDateReads: Reads[Date]

the default implicit java.util.Date reads

the default implicit java.util.Date reads

Inherited from
EnvReads
implicit val DefaultInstantReads: Reads[Instant]

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
implicit val DefaultJavaDurationReads: Reads[Duration]

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

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

See also

java.time.Duration

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

Inherited from
EnvReads
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).

See also

java.time.Period

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

Inherited from
EnvReads
implicit val DefaultLocalDateReads: Reads[LocalDate]

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

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

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

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

the default implicit SqlDate reads

the default implicit SqlDate reads

Inherited from
EnvReads
implicit val DefaultZonedDateTimeReads: Reads[ZonedDateTime]

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
implicit val ZoneIdReads: Reads[ZoneId]

Reads for the java.time.ZoneId type.

Reads for the java.time.ZoneId type.

Inherited from
EnvReads
implicit def keyMapReads[K, V](implicit evidence$3: KeyReads[K], fmtv: Reads[V]): Reads[Map[K, V]]
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

Inherited from
EnvReads
implicit def traversableReads[F[_], A](implicit bf: Factory[A, F[A]], ra: Reads[A]): Reads[F[A]]

Generic deserializer for collections types.

Generic deserializer for collections types.

Inherited from
LowPriorityDefaultReads