Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package libs

    Contains various APIs that are useful while developing web applications.

    Contains various APIs that are useful while developing web applications.

    Definition Classes
    api
  • package json

    Json API

    Json API

    For example:

    import play.api.libs.json._
import play.api.libs.functional.syntax._

case class User(id: Long, name: String, friends: Seq[User] = Seq.empty)
object User {

  // In this format, an undefined friends property is mapped to an empty list
  implicit val format: Format[User] = (
    (__ \ "id").format[Long] and
    (__ \ "name").format[String] and
    (__ \ "friends").lazyFormatNullable(implicitly[Format[Seq[User]]])
      .inmap[Seq[User]](_ getOrElse Seq.empty, Some(_))
  )(User.apply, unlift(User.unapply))
}

object MyController extends play.api.mvc.Controller {
   def displayUserAsJson(id: String) = Action {
      Ok(Json.toJson(User(id.toLong, "myName")))
   }

   def saveUser(jsonString: String)= Action {
     val user = Json.parse(jsonString).as[User]
     //myDataStore.save(user)
     Ok
   }
}
    Definition Classes
    libs
  • trait DefaultReads extends LowPriorityDefaultReads

    Default deserializer type classes.

    Default deserializer type classes.

    Definition Classes
    json
  • ArrayNodeReads
  • BigIntReads
  • BigIntegerReads
  • BooleanReads
  • ByteReads
  • DoubleReads
  • FloatReads
  • IntReads
  • IsoDateReads
  • JsArrayReads
  • JsBooleanReads
  • JsNumberReads
  • JsObjectReads
  • JsStringReads
  • JsValueReads
  • JsonNodeReads
  • LongReads
  • ObjectNodeReads
  • ShortReads
  • StringReads
  • TemporalParser
  • UUIDReader

implicit object JsObjectReads extends Reads[JsObject]

Deserializer for JsObject.

Source
Reads.scala
Linear Supertypes
Reads[JsObject], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsObjectReads
  2. Reads
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def andThen[B](rb: Reads[B])(implicit witness: <:<[JsObject, JsValue]): Reads[B]
    Definition Classes
    Reads
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. def collect[B](error: JsonValidationError)(f: PartialFunction[JsObject, B]): Reads[B]
    Definition Classes
    Reads
  8. def composeWith[B <: JsValue](rb: Reads[B]): Reads[JsObject]

    Creates a new Reads, which first passes the input JSON to rb, and then it executes this Reads on the pre-processed JSON (if rb has successfully handled the input JSON).

    Creates a new Reads, which first passes the input JSON to rb, and then it executes this Reads on the pre-processed JSON (if rb has successfully handled the input JSON).

    Definition Classes
    Reads
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def filter(error: JsonValidationError)(f: (JsObject) => Boolean): Reads[JsObject]
    Definition Classes
    Reads
  12. def filter(f: (JsObject) => Boolean): Reads[JsObject]
    Definition Classes
    Reads
  13. def filterNot(error: JsonValidationError)(f: (JsObject) => Boolean): Reads[JsObject]
    Definition Classes
    Reads
  14. def filterNot(f: (JsObject) => Boolean): Reads[JsObject]
    Definition Classes
    Reads
  15. def flatMap[B](f: (JsObject) => Reads[B]): Reads[B]
    Definition Classes
    Reads
  16. def flatMapResult[B](f: (JsObject) => JsResult[B]): Reads[B]

    Creates a new Reads, which transforms the successful result from the current instance using the given function.

    Creates a new Reads, which transforms the successful result from the current instance using the given function.

    f

    the function applied on the successful A value

    final class Foo private(val code: String) extends AnyVal

val A = new Foo("A")
val B = new Foo("B")

import play.api.libs.json.Reads

val r: Reads[Foo] = implicitly[Reads[String]].flatMapResult {
  case "A" => JsSuccess(A)
  case "B" => JsSuccess(B)
  case _   => JsError("error.expected.foo")
}
    Definition Classes
    Reads
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[B](f: (JsObject) => 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

    Definition Classes
    Reads
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. def orElse(v: Reads[JsObject]): Reads[JsObject]

    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
  25. def preprocess(f: PartialFunction[JsValue, JsValue]): Reads[JsObject]

    Creates a new Reads, which first transforms the input JSON using the given tranformer, and then it executes this Reads on the pre-processed JSON.

    Creates a new Reads, which first transforms the input JSON using the given tranformer, and then it executes this Reads on the pre-processed JSON.

    Definition Classes
    Reads
  26. def reads(json: JsValue): JsResult[JsObject]

    Convert the JsValue into a A

    Convert the JsValue into a A

    Definition Classes
    JsObjectReads → Reads
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. def widen[B >: JsObject]: Reads[B]

    Widen this Reads.

    Widen this Reads.

    import play.api.libs.json.Reads

sealed trait Animal
case class Dog(name: String) extends Animal
case class Cat(name: String) extends Animal

def simple(r: Reads[Dog]): Reads[Animal] = r.widen[Animal]
    Definition Classes
    Reads

Deprecated Value Members

  1. def compose[B <: JsValue](rb: Reads[B]): Reads[JsObject]
    Definition Classes
    Reads
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Use composeWith

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Reads[JsObject]

Inherited from AnyRef

Inherited from Any

Ungrouped