Trait/Object

play.api.libs.json

Format

Related Docs: object Format | package json

Permalink

trait Format[A] extends Writes[A] with Reads[A]

Json formatter: write an implicit to define both a serializer and a deserializer for any type.

Annotations
@implicitNotFound( ... )
Linear Supertypes
Reads[A], Writes[A], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Format
  2. Reads
  3. Writes
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def reads(json: JsValue): JsResult[A]

    Permalink

    Convert the JsValue into a A

    Convert the JsValue into a A

    Definition Classes
    Reads
  2. abstract def writes(o: A): JsValue

    Permalink

    Convert the object into a JsValue

    Convert the object into a JsValue

    Definition Classes
    Writes

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def andThen[B](rb: Reads[B])(implicit witness: <:<[A, JsValue]): Reads[B]

    Permalink
    Definition Classes
    Reads
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  7. def collect[B](error: JsonValidationError)(f: PartialFunction[A, B]): Reads[B]

    Permalink
    Definition Classes
    Reads
  8. def compose[B <: JsValue](rb: Reads[B]): Reads[A]

    Permalink
    Definition Classes
    Reads
  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def filter(error: JsonValidationError)(f: (A) ⇒ Boolean): Reads[A]

    Permalink
    Definition Classes
    Reads
  12. def filter(f: (A) ⇒ Boolean): Reads[A]

    Permalink
    Definition Classes
    Reads
  13. def filterNot(error: JsonValidationError)(f: (A) ⇒ Boolean): Reads[A]

    Permalink
    Definition Classes
    Reads
  14. def filterNot(f: (A) ⇒ Boolean): Reads[A]

    Permalink
    Definition Classes
    Reads
  15. def flatMap[B](f: (A) ⇒ Reads[B]): Reads[B]

    Permalink
    Definition Classes
    Reads
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def map[B](f: (A) ⇒ B): Reads[B]

    Permalink

    Create a new Reads which maps the value produced by this Reads.

    Create a new Reads which maps the value produced by this Reads.

    B

    The type of the value produced by the new Reads.

    f

    the function applied on the result of the current instance, if successful

    Definition Classes
    Reads
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  23. def orElse(v: Reads[A]): Reads[A]

    Permalink

    Creates a new Reads, based on this one, which first executes this Reads' logic then, if this Reads resulted in a JsError, runs the second Reads on the JsValue.

    Creates a new Reads, based on this one, which first executes this Reads' logic then, if this Reads resulted in a JsError, runs the second Reads on the JsValue.

    v

    The Reads to run if this one gets a JsError.

    returns

    A new Reads with the updated behavior.

    Definition Classes
    Reads
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  26. def transform(transformer: Writes[JsValue]): Writes[A]

    Permalink

    Transforms the resulting JsValue using a Writes[JsValue].

    Transforms the resulting JsValue using a Writes[JsValue].

    Definition Classes
    Writes
  27. def transform(transformer: (JsValue) ⇒ JsValue): Writes[A]

    Permalink

    Transforms the resulting JsValue using transformer function.

    Transforms the resulting JsValue using transformer function.

    Definition Classes
    Writes
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Reads[A]

Inherited from Writes[A]

Inherited from AnyRef

Inherited from Any

Ungrouped