play.api.libs.json

Reads

trait Reads[A] extends AnyRef

A Reads object describes how to decode JSON into a value. Reads objects are typically provided as implicit values. When Reads implicit values are in scope, a program is able to deserialize JSON into values of the right type.

The inverse of a Reads object is a Writes object, which describes how to encode a value into JSON. If you combine a Reads and a Writes then you get a Format.

Self Type
Reads[A]
Annotations
@implicitNotFound( ... )
Linear Supertypes
AnyRef, Any
Known Subclasses
ArrayNodeReads, BigIntReads, BigIntegerReads, BooleanReads, ByteReads, DoubleReads, FloatReads, Format, Format, IntReads, IsoDateReads, JsArrayReads, JsBooleanReads, JsNumberReads, JsObjectReads, JsStringReads, JsValueReads, JsonNodeReads, LongReads, OFormat, ObjectNodeReads, ShortReads, StringReads, UUIDReader
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Reads
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Convert the JsValue into a A

Concrete 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. def andThen[B](rb: Reads[B])(implicit witness: <:<[A, JsValue]): Reads[B]

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  9. def collect[B](error: JsonValidationError)(f: PartialFunction[A, B]): Reads[B]

  10. def compose[B <: JsValue](rb: Reads[B]): Reads[A]

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def filter(error: JsonValidationError)(f: (A) ⇒ Boolean): Reads[A]

  14. def filter(f: (A) ⇒ Boolean): Reads[A]

  15. def filterNot(error: JsonValidationError)(f: (A) ⇒ Boolean): Reads[A]

  16. def filterNot(f: (A) ⇒ Boolean): Reads[A]

  17. def flatMap[B](f: (A) ⇒ Reads[B]): Reads[B]

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

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. def map[B](f: (A) ⇒ B): Reads[B]

    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

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  25. def orElse(v: Reads[A]): Reads[A]

    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.

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  27. def toString(): String

    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    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 AnyRef

Inherited from Any

Ungrouped