play.api.libs.json

Reads

object Reads extends ConstraintReads with PathReads with DefaultReads

Default deserializer type classes.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Reads
  2. DefaultReads
  3. LowPriorityDefaultReads
  4. EnvReads
  5. PathReads
  6. ConstraintReads
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class UUIDReader extends Reads[UUID]

    Deserializer for java.

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. implicit def ArrayReads[T](implicit arg0: Reads[T], arg1: ClassTag[T]): Reads[Array[T]]

    Deserializer for Array[T] types.

    Deserializer for Array[T] types.

    Definition Classes
    DefaultReads
  7. implicit object BooleanReads extends Reads[Boolean]

    Deserializer for Boolean types.

  8. implicit object ByteReads extends Reads[Byte]

    Deserializer for Byte types.

  9. implicit object DoubleReads extends Reads[Double]

    Deserializer for Double types.

  10. implicit object FloatReads extends Reads[Float]

    Deserializer for Float types.

  11. implicit object IntReads extends Reads[Int]

    Deserializer for Int types.

  12. implicit object JsArrayMonoid extends Monoid[JsArray]

  13. implicit object JsArrayReads extends Reads[JsArray]

    Deserializer for JsArray.

  14. implicit val JsArrayReducer: Reducer[JsValue, JsArray]

  15. implicit object JsBooleanReads extends Reads[JsBoolean]

    Deserializer for JsBoolean.

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

    Definition Classes
    DefaultReads
  17. implicit object JsNumberReads extends Reads[JsNumber]

    Deserializer for JsNumber.

  18. implicit object JsObjectMonoid extends Monoid[JsObject]

  19. implicit object JsObjectReads extends Reads[JsObject]

    Deserializer for JsObject.

  20. implicit val JsObjectReducer: Reducer[JsObject, JsObject]

  21. implicit object JsStringReads extends Reads[JsString]

    Deserializer for JsString.

  22. implicit object JsValueReads extends Reads[JsValue]

    Deserializer for JsValue.

  23. implicit object LongReads extends Reads[Long]

    Deserializer for Long types.

  24. implicit object ShortReads extends Reads[Short]

    Deserializer for Short types.

  25. implicit object StringReads extends Reads[String]

    Deserializer for String types.

  26. implicit def alternative(implicit a: Applicative[Reads]): Alternative[Reads]

  27. implicit def applicative(implicit applicativeJsResult: Applicative[JsResult]): Applicative[Reads]

  28. def apply[A](f: (JsValue) ⇒ JsResult[A]): Reads[A]

  29. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  30. def at[A](path: JsPath)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads
  31. implicit val bigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  32. def charMapReads[V](implicit vr: Reads[V]): Reads[Map[Char, V]]

    Deserializer for a Map[Char, V]

    Deserializer for a Map[Char, V]

    Definition Classes
    DefaultReads
  33. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. val constraints: ConstraintReads

  35. def email(implicit reads: Reads[String]): Reads[String]

    Definition Classes
    ConstraintReads
  36. def enumNameReads[E <: Enumeration](enum: E): Reads[DefaultReads.enumNameReads.E.Value]

    Reads for scala.Enumeration types using the name.

    Reads for scala.Enumeration types using the name.

    enum

    a scala.Enumeration.

    Definition Classes
    DefaultReads
  37. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  39. def filter[A](otherwise: JsonValidationError)(p: (A) ⇒ Boolean)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  40. def filterNot[A](error: JsonValidationError)(p: (A) ⇒ Boolean)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  41. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. implicit def functorReads(implicit a: Applicative[Reads]): Functor[Reads]

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

    Definition Classes
    AnyRef → Any
  44. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  45. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  46. implicit val javaBigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  47. def jsCopyTo[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads
  48. def jsPick[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads
  49. def jsPickBranch[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads
  50. def jsPrune(path: JsPath): Reads[JsObject]

    Definition Classes
    PathReads
  51. def jsPut(path: JsPath, a: ⇒ JsValue): Reads[JsObject]

    Definition Classes
    PathReads
  52. def jsUpdate[A <: JsValue](path: JsPath)(reads: Reads[A]): Reads[JsObject]

    Definition Classes
    PathReads
  53. def list[A](implicit reads: Reads[A]): Reads[List[A]]

    Definition Classes
    ConstraintReads
  54. def map[A](implicit reads: Reads[A]): Reads[Map[String, A]]

    Definition Classes
    ConstraintReads
  55. implicit def mapReads[V](implicit fmtv: Reads[V]): Reads[Map[String, V]]

    Deserializer for a Map[String,V]

    Deserializer for a Map[String,V]

    Definition Classes
    DefaultReads
  56. 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]

    Definition Classes
    DefaultReads
  57. def max[O](m: O)(implicit reads: Reads[O], ord: Ordering[O]): Reads[O]

    Defines a maximum value for a Reads.

    Defines a maximum value for a Reads. Combine with min using andKeep, e.g. .read(Reads.min(0.1) andKeep Reads.max(1.0)).

    Definition Classes
    ConstraintReads
  58. def maxLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

    Definition Classes
    ConstraintReads
  59. def min[O](m: O)(implicit reads: Reads[O], ord: Ordering[O]): Reads[O]

    Defines a minimum value for a Reads.

    Defines a minimum value for a Reads. Combine with max using andKeep, e.g. .read(Reads.min(0) andKeep Reads.max(100)).

    Definition Classes
    ConstraintReads
  60. def minLength[M](m: Int)(implicit reads: Reads[M], p: (M) ⇒ TraversableLike[_, M]): Reads[M]

    Definition Classes
    ConstraintReads
  61. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  62. final def notify(): Unit

    Definition Classes
    AnyRef
  63. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  64. def nullable[A](path: JsPath)(implicit reads: Reads[A]): Reads[Option[A]]

    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 except last node: - If one node in JsPath is not found before last node => returns JsError( "missing-path" ) - If all nodes are found till last node, it runs through JsValue with last node =>

    • If last node if not found => returns None
    • If last node is found with value "null" => returns None
    • If last node is found => applies implicit Reads[T]
    Definition Classes
    PathReads
  65. def nullableWithDefault[A](path: JsPath, defaultValue: ⇒ Option[A])(implicit reads: Reads[A]): Reads[Option[A]]

    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 except last node: - If one node in JsPath is not found before last node => returns JsError( "missing-path" ) - If all nodes are found till last node, it runs through JsValue with last node =>

    • If last node if not found => returns JsError( "missing-path" )
    • If last node is found with value "null" => returns None
    • If last node is found => applies implicit Reads[T]
    Definition Classes
    PathReads
  66. def of[A](implicit r: Reads[A]): Reads[A]

    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

    Definition Classes
    ConstraintReads
  67. def optionNoError[A](implicit reads: Reads[A]): Reads[Option[A]]

    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

    Definition Classes
    ConstraintReads
  68. def optionWithNull[T](implicit rds: Reads[T]): Reads[Option[T]]

    very simple optional field Reads that maps "null" to None

    very simple optional field Reads that maps "null" to None

    Definition Classes
    ConstraintReads
  69. val path: PathReads

  70. def pattern(regex: ⇒ Regex, error: String = "error.pattern")(implicit reads: Reads[String]): Reads[String]

    Defines a regular expression constraint for String values, i.

    Defines a regular expression constraint for String values, i.e. the string must match the regular expression pattern

    Definition Classes
    ConstraintReads
  71. def pure[A](a: A): Reads[A]

    Returns a JsSuccess(a) (with root path) for any JSON value read.

  72. def pure[A](a: ⇒ A): Reads[A]

    Definition Classes
    ConstraintReads
  73. def required(path: JsPath)(implicit reads: Reads[JsValue]): Reads[JsValue]

    Definition Classes
    PathReads
  74. def seq[A](implicit reads: Reads[A]): Reads[Seq[A]]

    Definition Classes
    ConstraintReads
  75. def set[A](implicit reads: Reads[A]): Reads[Set[A]]

    Definition Classes
    ConstraintReads
  76. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  77. def toString(): String

    Definition Classes
    AnyRef → Any
  78. implicit def traversableReads[F[_], A](implicit bf: CanBuildFrom[F[_], A, F[A]], ra: Reads[A]): Reads[F[A]]

    Generic deserializer for collections types.

    Generic deserializer for collections types.

    Definition Classes
    LowPriorityDefaultReads
  79. implicit val uuidReads: Reads[UUID]

    Definition Classes
    DefaultReads
  80. def verifying[A](cond: (A) ⇒ Boolean)(implicit rds: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  81. def verifyingIf[A](cond: (A) ⇒ Boolean)(subreads: Reads[_])(implicit rds: Reads[A]): Reads[A]

    Definition Classes
    ConstraintReads
  82. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. def withDefault[A](path: JsPath, defaultValue: ⇒ A)(implicit reads: Reads[A]): Reads[A]

    Definition Classes
    PathReads

Inherited from DefaultReads

Inherited from LowPriorityDefaultReads

Inherited from EnvReads

Inherited from PathReads

Inherited from ConstraintReads

Inherited from AnyRef

Inherited from Any

Ungrouped