Packages

  • package root
    Definition Classes
    root
  • package play
    Definition Classes
    root
  • package api
    Definition Classes
    play
  • package libs
    Definition Classes
    api
  • package json

    Json API For example:

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

//then in a controller:

object MyController extends 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
  • class JsMacroImpl extends AnyRef

    Implementation for the JSON macro.

    Implementation for the JSON macro.

    Definition Classes
    json
  • object Placeholder

    Only for internal purposes

    Only for internal purposes

    Definition Classes
    JsMacroImpl
  • Format

implicit object Format extends OFormat[Placeholder]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Format
  2. OFormat
  3. Format
  4. Reads
  5. OWrites
  6. Writes
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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: <:<[Placeholder, JsValue]): Reads[B]
    Definition Classes
    Reads
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def collect[B](error: JsonValidationError)(f: PartialFunction[Placeholder, B]): Reads[B]
    Definition Classes
    Reads
  8. def composeWith[B <: JsValue](rb: Reads[B]): Reads[Placeholder]

    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. def contramap[B](f: (B) ⇒ Placeholder): OWrites[B]

    Returns a new instance that first converts a B value to a A one, before converting this A value into a JsValue.

    Returns a new instance that first converts a B value to a A one, before converting this A value into a JsValue.

    Definition Classes
    OWrites → Writes
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def filter(error: JsonValidationError)(f: (Placeholder) ⇒ Boolean): Reads[Placeholder]
    Definition Classes
    Reads
  13. def filter(f: (Placeholder) ⇒ Boolean): Reads[Placeholder]
    Definition Classes
    Reads
  14. def filterNot(error: JsonValidationError)(f: (Placeholder) ⇒ Boolean): Reads[Placeholder]
    Definition Classes
    Reads
  15. def filterNot(f: (Placeholder) ⇒ Boolean): Reads[Placeholder]
    Definition Classes
    Reads
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def flatMap[B](f: (Placeholder) ⇒ Reads[B]): Reads[B]
    Definition Classes
    Reads
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def map[B](f: (Placeholder) ⇒ 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
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def orElse(v: Reads[Placeholder]): Reads[Placeholder]

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

    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
  27. def reads(json: JsValue): JsResult[Placeholder]

    Convert the JsValue into a A

    Convert the JsValue into a A

    Definition Classes
    Format → Reads
  28. val success: JsSuccess[Placeholder]
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. def transform(transformer: OWrites[JsObject]): OWrites[Placeholder]

    Transforms the resulting JsValue using a Writes[JsValue].

    Transforms the resulting JsValue using a Writes[JsValue].

    Definition Classes
    OWrites
  32. def transform(transformer: (JsObject) ⇒ JsObject): OWrites[Placeholder]

    Transforms the resulting JsObject using a transformer function.

    Transforms the resulting JsObject using a transformer function.

    Definition Classes
    OWrites
  33. def transform(transformer: Writes[JsValue]): Writes[Placeholder]

    Transforms the resulting JsValue using a Writes[JsValue].

    Transforms the resulting JsValue using a Writes[JsValue].

    Definition Classes
    Writes
  34. def transform(transformer: (JsValue) ⇒ JsValue): Writes[Placeholder]

    Transforms the resulting JsValue using transformer function.

    Transforms the resulting JsValue using transformer function.

    Definition Classes
    Writes
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  38. def widen[B >: Placeholder]: Reads[B]

    Widen this Reads.

    Widen this Reads.

    import play.api.libs.json.Reads

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

def combine(dog: Reads[Dog], cat: Reads[Cat]): Reads[Animal] =
  dog.orElse(cat).orElse(Reads.failed[Animal]("Unsupported Animal"))
    Definition Classes
    Reads
  39. def writes(pl: Placeholder): JsObject

    Converts the A value into a JsValue.

    Converts the A value into a JsValue.

    Definition Classes
    Format → OWrites → Writes

Deprecated Value Members

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

    (Since version 2.7.0) Use composeWith

Inherited from OFormat[Placeholder]

Inherited from Format[Placeholder]

Inherited from Reads[Placeholder]

Inherited from OWrites[Placeholder]

Inherited from Writes[Placeholder]

Inherited from AnyRef

Inherited from Any

Ungrouped