play-json
API
Generated with
play-json/play.api.libs.json/DefaultWrites

DefaultWrites

play.api.libs.json.DefaultWrites
trait DefaultWrites extends LowPriorityWrites

Default Serializers.

Attributes

Graph
Supertypes
trait EnvWrites
class Object
trait Matchable
class Any
Known subtypes
object Writes.type

Members list

Type members

Classlikes

object BigDecimalWrites extends Writes[BigDecimal]

Serializer for BigDecimal types.

Serializer for BigDecimal types.

Attributes

Supertypes
trait Writes[BigDecimal]
class Object
trait Matchable
class Any
Self type
object BigIntWrites extends Writes[BigInt]

Serializer for BigInt type.

Serializer for BigInt type.

Attributes

Supertypes
trait Writes[BigInt]
class Object
trait Matchable
class Any
Self type
object BigIntegerWrites extends Writes[BigInteger]

Serializer for BigInteger type.

Serializer for BigInteger type.

Attributes

Supertypes
trait Writes[BigInteger]
class Object
trait Matchable
class Any
Self type
object BooleanWrites extends Writes[Boolean]

Serializer for Boolean types.

Serializer for Boolean types.

Attributes

Supertypes
trait Writes[Boolean]
class Object
trait Matchable
class Any
Self type
object ByteWrites extends Writes[Byte]

Serializer for Byte types.

Serializer for Byte types.

Attributes

Supertypes
trait Writes[Byte]
class Object
trait Matchable
class Any
Self type
ByteWrites.type
object DoubleWrites extends Writes[Double]

Serializer for Double types.

Serializer for Double types.

Attributes

Supertypes
trait Writes[Double]
class Object
trait Matchable
class Any
Self type
object FloatWrites extends Writes[Float]

Serializer for Float types.

Serializer for Float types.

Attributes

Supertypes
trait Writes[Float]
class Object
trait Matchable
class Any
Self type
object IntWrites extends Writes[Int]

Serializer for Int types.

Serializer for Int types.

Attributes

Supertypes
trait Writes[Int]
class Object
trait Matchable
class Any
Self type
IntWrites.type
object LongWrites extends Writes[Long]

Serializer for Long types.

Serializer for Long types.

Attributes

Supertypes
trait Writes[Long]
class Object
trait Matchable
class Any
Self type
LongWrites.type
object ShortWrites extends Writes[Short]

Serializer for Short types.

Serializer for Short types.

Attributes

Supertypes
trait Writes[Short]
class Object
trait Matchable
class Any
Self type
object StringWrites extends Writes[String]

Serializer for String types.

Serializer for String types.

Attributes

Supertypes
trait Writes[String]
class Object
trait Matchable
class Any
Self type
object UuidWrites extends Writes[UUID]

Serializer for java.util.UUID

Serializer for java.util.UUID

Attributes

Supertypes
trait Writes[UUID]
class Object
trait Matchable
class Any
Self type
UuidWrites.type

Deprecated classlikes

object DefaultDateWrites extends Writes[Date]

Attributes

Deprecated
true
Supertypes
trait Writes[Date]
class Object
trait Matchable
class Any
Self type
object JsValueWrites extends Writes[JsValue]

Attributes

Deprecated
true
Supertypes
trait Writes[JsValue]
class Object
trait Matchable
class Any
Self type

Inherited classlikes

object TemporalFormatter

Formatting companion

Formatting companion

Attributes

Inherited from:
EnvWrites
Supertypes
class Object
trait Matchable
class Any
trait TemporalFormatter[T <: Temporal]

Typeclass to implement way of formatting of Java8 temporal types.

Typeclass to implement way of formatting of Java8 temporal types.

Attributes

Inherited from:
EnvWrites
Supertypes
class Object
trait Matchable
class Any

Deprecated and Inherited classlikes

object JsonNodeWrites extends Writes[JsonNode]

Attributes

Deprecated
true
Inherited from:
EnvWrites
Supertypes
trait Writes[JsonNode]
class Object
trait Matchable
class Any

Value members

Concrete methods

def dateWrites(pattern: String): Writes[Date]

Serializer for java.util.Date

Serializer for java.util.Date

Value parameters

pattern

the pattern used by SimpleDateFormat

Attributes

Deprecated methods

def sqlDateWrites(pattern: String): Writes[Date]

Serializer for java.sql.Date

Serializer for java.sql.Date

Value parameters

pattern

the pattern used by SimpleDateFormat

Attributes

Deprecated
true

Inherited methods

def temporalWrites[A <: Temporal, B](formatting: B)(implicit f: B => TemporalFormatter[A]): Writes[A]

Serializer for Java8 temporal types (e.g. java.time.LocalDateTime) to be written as JSON string.

Serializer for Java8 temporal types (e.g. java.time.LocalDateTime) to be written as JSON string.

Type parameters

A

the Java8 temporal type to be considered: LocalDateTime, ZonedDateTime, Instant

B

Type of formatting argument

Value parameters

formatting

an argument to instantiate formatter

import java.time.LocalDateTime
import java.time.format.DateTimeFormatter
import play.api.libs.json.Writes
implicit val w: Writes[LocalDateTime] =
 Writes.temporalWrites[LocalDateTime, DateTimeFormatter](
   DateTimeFormatter.ISO_LOCAL_DATE_TIME)

Attributes

Inherited from:
EnvWrites

Deprecated and Inherited methods

def iterableWrites[A, M <: (Iterable)](implicit w: Writes[A]): Writes[M[A]]

Serializer for Iterable types.

Serializer for Iterable types.

Deprecated due to incompatibility with non _[_] shapes, #368.

Attributes

Deprecated
true
Inherited from:
LowPriorityWrites
def traversableWrites[A : Writes]: Writes[Iterable[A]]

Attributes

Deprecated
true
Inherited from:
LowPriorityWrites

Inherited fields

val InstantEpochMilliWrites: Writes[Instant]

Serializer for java.time.Instant as JSON number. The number of milliseconds since epoch is used.

Serializer for java.time.Instant as JSON number. The number of milliseconds since epoch is used.

import java.time.Instant
import play.api.libs.json.Writes

implicit val inWrites: Writes[Instant] = Writes.InstantEpochMilliWrites

Attributes

Inherited from:
EnvWrites
val LocalDateEpochMilliWrites: Writes[LocalDate]

Serializer for java.time.LocalDate as JSON number. The number of milliseconds since epoch is used.

Serializer for java.time.LocalDate as JSON number. The number of milliseconds since epoch is used.

import java.time.LocalDate
import play.api.libs.json.Writes

implicit val ldnWrites: Writes[LocalDate] =
 Writes.LocalDateEpochMilliWrites

Attributes

Inherited from:
EnvWrites
val LocalDateTimeEpochMilliWrites: Writes[LocalDateTime]

Serializer for java.time.LocalDateTime as JSON number. The number of milliseconds since epoch is used.

Serializer for java.time.LocalDateTime as JSON number. The number of milliseconds since epoch is used.

import java.time.LocalDateTime
import play.api.libs.json.Writes

implicit val ldtnWrites = Writes.LocalDateTimeEpochMilliWrites

Attributes

Inherited from:
EnvWrites
val LocalTimeNanoOfDayWrites: Writes[LocalTime]

Serializer for java.time.LocalTime as JSON number. The nano of day is written.

Serializer for java.time.LocalTime as JSON number. The nano of day is written.

import java.time.LocalTime
import play.api.libs.json.Writes

implicit val ltnWrites = Writes.LocalTimeNanoOfDayWrites

Attributes

Inherited from:
EnvWrites
val ZonedDateTimeEpochMilliWrites: Writes[ZonedDateTime]

Serializer for java.time.ZonedDateTime as JSON number. The number of milliseconds since epoch is used.

Serializer for java.time.ZonedDateTime as JSON number. The number of milliseconds since epoch is used.

import java.time.ZonedDateTime
import play.api.libs.json.Writes

implicit val zdtnWrites = Writes.ZonedDateTimeEpochMilliWrites

Attributes

Inherited from:
EnvWrites
val javaDurationMillisWrites: Writes[Duration]

Serializer of Java Duration as a number of milliseconds.

Serializer of Java Duration as a number of milliseconds.

Attributes

Inherited from:
EnvWrites
val localeObjectWrites: OWrites[Locale]

Serializer for a Locale using a object representation

Serializer for a Locale using a object representation

Attributes

Inherited from:
EnvWrites

Givens

Inherited givens

given enumNameWrites[E <: Enumeration](using e: ValueOf[E]): Writes[Value]

Serializer for scala.Enumeration by name.

Serializer for scala.Enumeration by name.

Attributes

Inherited from:
EnumerationWrites (hidden)

Implicits

Implicits

implicit val NoneWrites: Writes[None.type]

Serializer for JsNull.

Serializer for JsNull.

import play.api.libs.json.Json

Json.obj("foo" -> None)
// equivalent to Json.obj("foo" -> JsNull)

Attributes

implicit def OptionWrites[T](implicit fmt: Writes[T]): Writes[Option[T]]

Serializer for Option.

Serializer for Option.

Attributes

implicit def arrayWrites[T : Writes]: Writes[Array[T]]

Serializer for Array[T] types.

Serializer for Array[T] types.

Attributes

implicit def defaultDateWrites[T <: Date]: Writes[T]

Default Serializer java.util.Date -> JsNumber(d.getTime (nb of ms))

Default Serializer java.util.Date -> JsNumber(d.getTime (nb of ms))

Attributes

implicit def genericMapWrites[V, M <: (Map)](implicit w: Writes[V]): OWrites[M[String, V]]

Serializer for Map[String,V] types.

Serializer for Map[String,V] types.

Attributes

implicit def jsValueWrites[T <: JsValue]: Writes[T]

Serializer for JsValues.

Serializer for JsValues.

Attributes

implicit def keyMapWrites[K : KeyWrites, V : Writes, M <: (Map)]: OWrites[M[K, V]]
implicit def rangeWrites[T <: Range]: Writes[T]

Serializer for scala.collection.immutable.Range (aka specialized Seq of Int).

Serializer for scala.collection.immutable.Range (aka specialized Seq of Int).

Attributes

implicit def someWrites[T](implicit w: Writes[T]): Writes[Some[T]]

If Some is directly used (not as Option).

If Some is directly used (not as Option).

import play.api.libs.json.{ Json, Writes }

def foo[T: Writes](writeableValue: T) =
 Json.obj("foo" -> Some(writeableValue))
 // equivalent to Json.obj("foo" -> writeableValue)

Attributes

Deprecated implicits

implicit def mapWrites[V : Writes]: OWrites[Map[String, V]]

Serializer for Map[String,V] types.

Serializer for Map[String,V] types.

Attributes

Deprecated
true

Inherited implicits

implicit val DefaultInstantWrites: Writes[Instant]

The default typeclass to write a java.time.Instant, using '2011-12-03T10:15:30Z' format.

The default typeclass to write a java.time.Instant, using '2011-12-03T10:15:30Z' format.

Attributes

Inherited from:
EnvWrites
implicit val DefaultLocalDateTimeWrites: Writes[LocalDateTime]

The default typeclass to write a java.time.LocalDateTime, using '2011-12-03T10:15:30' format.

The default typeclass to write a java.time.LocalDateTime, using '2011-12-03T10:15:30' format.

Attributes

Inherited from:
EnvWrites
implicit val DefaultLocalDateWrites: Writes[LocalDate]

The default typeclass to write a java.time.LocalDate, using '2011-12-03' format.

The default typeclass to write a java.time.LocalDate, using '2011-12-03' format.

Attributes

Inherited from:
EnvWrites
implicit val DefaultLocalTimeWrites: Writes[LocalTime]

The default typeclass to write a java.time.LocalTime, using '10:15:30' format.

The default typeclass to write a java.time.LocalTime, using '10:15:30' format.

Attributes

Inherited from:
EnvWrites
implicit val DefaultOffsetDateTimeWrites: Writes[OffsetDateTime]

The default typeclass to write a java.time.OffsetDateTime, using '2011-12-03T10:15:30+02:00' format.

The default typeclass to write a java.time.OffsetDateTime, using '2011-12-03T10:15:30+02:00' format.

Attributes

Inherited from:
EnvWrites
implicit val DefaultZonedDateTimeWrites: Writes[ZonedDateTime]

The default typeclass to write a java.time.ZonedDateTime, using '2011-12-03T10:15:30+01:00[Europe/Paris]' format.

The default typeclass to write a java.time.ZonedDateTime, using '2011-12-03T10:15:30+01:00[Europe/Paris]' format.

Attributes

Inherited from:
EnvWrites
implicit val ZoneIdWrites: Writes[ZoneId]

Serializer for java.time.ZoneId as JSON string.

Serializer for java.time.ZoneId as JSON string.

Attributes

Inherited from:
EnvWrites
implicit def iterableWrites2[A, I](implicit ev: I <:< Iterable[A], w: Writes[A]): Writes[I]

Serializer for Iterable types.

Serializer for Iterable types.

Attributes

Inherited from:
LowPriorityWrites
implicit val javaDurationWrites: Writes[Duration]

Serializer of Java Duration using ISO representation (e.g. PT1S for 1 second).

Serializer of Java Duration using ISO representation (e.g. PT1S for 1 second).

Attributes

Inherited from:
EnvWrites
implicit val javaPeriodWrites: Writes[Period]

Serializer of Java Period using ISO representation (e.g. P2D for 2 days).

Serializer of Java Period using ISO representation (e.g. P2D for 2 days).

Attributes

Inherited from:
EnvWrites
implicit def jsonNodeWrites[T <: JsonNode]: Writes[T]

Serializer for Jackson JsonNode

Serializer for Jackson JsonNode

Attributes

Inherited from:
EnvWrites
implicit val localeWrites: Writes[Locale]

Serializer for a Locale using the IETF BCP 47 string representation

Serializer for a Locale using the IETF BCP 47 string representation

Attributes

Inherited from:
EnvWrites
implicit def stringableWrites[T](implicit conv: T => String): Writes[T]

Serializer for any type that is provided an implicit conversion to String (e.g. tagged types).

Serializer for any type that is provided an implicit conversion to String (e.g. tagged types).

Attributes

Inherited from:
LowPriorityWrites
implicit val uriWrites: Writes[URI]

Serializer for java.net.URI

Serializer for java.net.URI

Attributes

Inherited from:
LowPriorityWrites
Generated with