Object/Class

play.api.libs.json

JsPath

Related Docs: class JsPath | package json

Permalink

object JsPath extends JsPath

Companion object and root path.

For an object { "name": "foo" }, the path to the name property is:

JsPath \ "name"

For an object { "id": 1, "nested": { "score": 0.12 } }, the path to the nested score is:

JsPath \ "nested" \ "score"
Source
JsPath.scala
Linear Supertypes
JsPath, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsPath
  2. JsPath
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(other: JsPath): JsPath

    Permalink
    Definition Classes
    JsPath
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def \(idx: Int): JsPath

    Permalink
    Definition Classes
    JsPath
  6. def \(child: Symbol): JsPath

    Permalink
    Definition Classes
    JsPath
  7. def \(child: String): JsPath

    Permalink
    Definition Classes
    JsPath
  8. def \\(child: Symbol): JsPath

    Permalink
    Definition Classes
    JsPath
  9. def \\(child: String): JsPath

    Permalink
    Definition Classes
    JsPath
  10. def apply(json: JsValue): List[JsValue]

    Permalink
    Definition Classes
    JsPath
  11. def apply(idx: Int): JsPath

    Permalink
    Definition Classes
    JsPath
  12. def applyTillLast(json: JsValue): Either[JsError, JsResult[JsValue]]

    Permalink
    Definition Classes
    JsPath
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def asSingleJsResult(json: JsValue): JsResult[JsValue]

    Permalink
    Definition Classes
    JsPath
  15. def asSingleJson(json: JsValue): JsLookupResult

    Permalink
    Definition Classes
    JsPath
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def compose(other: JsPath): JsPath

    Permalink
    Definition Classes
    JsPath
  18. def createObj(pathValues: (JsPath, JsValue)*): JsObject

    Permalink
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def format[T](w: Writes[T])(implicit r: Reads[T]): OFormat[T]

    Permalink

    Reads/Writes a T at JsPath using provided explicit Writes[T] and implicit Reads[T]

    Reads/Writes a T at JsPath using provided explicit Writes[T] and implicit Reads[T]

    Definition Classes
    JsPath
  22. def format[T](r: Reads[T])(implicit w: Writes[T]): OFormat[T]

    Permalink

    Reads/Writes a T at JsPath using provided explicit Reads[T] and implicit Writes[T]

    Reads/Writes a T at JsPath using provided explicit Reads[T] and implicit Writes[T]

    Definition Classes
    JsPath
  23. def format[T](implicit f: Format[T]): OFormat[T]

    Permalink

    Reads/Writes a T at JsPath using provided implicit Format[T]

    Reads/Writes a T at JsPath using provided implicit Format[T]

    Definition Classes
    JsPath
  24. def formatNullable[T](implicit f: Format[T]): OFormat[Option[T]]

    Permalink

    Reads/Writes a Option[T] (optional or nullable field) at given JsPath

    Reads/Writes a Option[T] (optional or nullable field) at given JsPath

    Definition Classes
    JsPath
    See also

    JsPath.writeNullable to see behavior in writes

    JsPath.readNullable to see behavior in reads

  25. def formatNullableWithDefault[T](defaultValue: ⇒ Option[T])(implicit f: Format[T]): OFormat[Option[T]]

    Permalink

    Reads/Writes a Option[T] (nullable field) at given JsPath

    Reads/Writes a Option[T] (nullable field) at given JsPath

    Definition Classes
    JsPath
    See also

    JsPath.writeNullable to see behavior in writes

    JsPath.readNullableWithDefault to see behavior in reads

  26. def formatWithDefault[T](defaultValue: ⇒ T)(implicit f: Format[T]): OFormat[T]

    Permalink

    Reads/Writes a T at JsPath using provided implicit Format[T] with fallback to default value

    Reads/Writes a T at JsPath using provided implicit Format[T] with fallback to default value

    Definition Classes
    JsPath
  27. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  29. object json

    Permalink
    Definition Classes
    JsPath
  30. def lazyFormat[T](r: ⇒ Reads[T], w: ⇒ Writes[T]): OFormat[T]

    Permalink

    Lazy Reads/Writes a T at given JsPath using explicit Reads[T] and Writes[T] (useful in case of recursive case classes).

    Lazy Reads/Writes a T at given JsPath using explicit Reads[T] and Writes[T] (useful in case of recursive case classes).

    Definition Classes
    JsPath
    See also

    JsPath.lazyWriteNullable to see behavior in writes

    JsPath.lazyReadNullable to see behavior in reads

  31. def lazyFormat[T](f: ⇒ Format[T]): OFormat[T]

    Permalink

    Lazy Reads/Writes a T at given JsPath using implicit Format[T] (useful in case of recursive case classes).

    Lazy Reads/Writes a T at given JsPath using implicit Format[T] (useful in case of recursive case classes).

    Definition Classes
    JsPath
    See also

    JsPath.lazyWriteNullable to see behavior in writes

    JsPath.lazyReadNullable to see behavior in reads

  32. def lazyFormatNullable[T](r: ⇒ Reads[T], w: ⇒ Writes[T]): OFormat[Option[T]]

    Permalink

    Lazy Reads/Writes a Option[T] (optional or nullable field) at given JsPath using explicit Reads[T] and Writes[T] (useful in case of recursive case classes).

    Lazy Reads/Writes a Option[T] (optional or nullable field) at given JsPath using explicit Reads[T] and Writes[T] (useful in case of recursive case classes).

    Definition Classes
    JsPath
    See also

    JsPath.lazyWriteNullable to see behavior in writes

    JsPath.lazyReadNullable to see behavior in reads

  33. def lazyFormatNullable[T](f: ⇒ Format[T]): OFormat[Option[T]]

    Permalink

    Lazy Reads/Writes a Option[T] (optional or nullable field) at given JsPath using implicit Format[T] (useful in case of recursive case classes).

    Lazy Reads/Writes a Option[T] (optional or nullable field) at given JsPath using implicit Format[T] (useful in case of recursive case classes).

    Definition Classes
    JsPath
    See also

    JsPath.lazyWriteNullable to see behavior in writes

    JsPath.lazyReadNullable to see behavior in reads

  34. def lazyRead[T](r: ⇒ Reads[T]): Reads[T]

    Permalink

    Reads a T at JsPath using the explicit Reads[T] passed by name which is useful in case of recursive case classes for ex.

    Reads a T at JsPath using the explicit Reads[T] passed by name which is useful in case of recursive case classes for ex.

    case class User(id: Long, name: String, friend: User)
    
    implicit lazy val UserReads: Reads[User] = (
      (__ \ 'id).read[Long] and
      (__ \ 'name).read[String] and
      (__ \ 'friend).lazyRead(UserReads)
    )(User.apply _)
    Definition Classes
    JsPath
  35. def lazyReadNullable[T](r: ⇒ Reads[T]): Reads[Option[T]]

    Permalink

    Reads lazily a Option[T] search optional or nullable field at JsPath using the explicit Reads[T] passed by name which is useful in case of recursive case classes for ex.

    Reads lazily a Option[T] search optional or nullable field at JsPath using the explicit Reads[T] passed by name which is useful in case of recursive case classes for ex.

    case class User(id: Long, name: String, friend: Option[User])
    
    implicit lazy val UserReads: Reads[User] = (
      (__ \ 'id).read[Long] and
      (__ \ 'name).read[String] and
      (__ \ 'friend).lazyReadNullable(UserReads)
    )(User.apply _)
    Definition Classes
    JsPath
  36. def lazyWrite[T](w: ⇒ Writes[T]): OWrites[T]

    Permalink

    Writes a T at JsPath using the explicit Writes[T] passed by name which is useful in case of recursive case classes for ex

    Writes a T at JsPath using the explicit Writes[T] passed by name which is useful in case of recursive case classes for ex

    case class User(id: Long, name: String, friend: User)
    
    implicit lazy val UserReads: Reads[User] = (
      (__ \ 'id).write[Long] and
      (__ \ 'name).write[String] and
      (__ \ 'friend).lazyWrite(UserReads)
    )(User.apply _)
    Definition Classes
    JsPath
  37. def lazyWriteNullable[T](w: ⇒ Writes[T]): OWrites[Option[T]]

    Permalink

    Writes a Option[T] at JsPath using the explicit Writes[T] passed by name which is useful in case of recursive case classes for ex

    Writes a Option[T] at JsPath using the explicit Writes[T] passed by name which is useful in case of recursive case classes for ex

    Please note that it's not writeOpt to be coherent with readNullable

    case class User(id: Long, name: String, friend: Option[User])
    
    implicit lazy val UserReads: Reads[User] = (
      (__ \ 'id).write[Long] and
      (__ \ 'name).write[String] and
      (__ \ 'friend).lazyWriteNullable(UserReads)
    )(User.apply _)
    Definition Classes
    JsPath
  38. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  41. val path: List[PathNode]

    Permalink
    Definition Classes
    JsPath
  42. def prune(js: JsValue): JsResult[JsObject]

    Permalink

    Simple Prune for simple path and only JsObject

    Simple Prune for simple path and only JsObject

    Definition Classes
    JsPath
  43. def read[T](t: T): Reads[T]

    Permalink

    Pure Reads doesn't read anything but creates a JsObject based on JsPath with the given T value

    Pure Reads doesn't read anything but creates a JsObject based on JsPath with the given T value

    Definition Classes
    JsPath
  44. def read[T](implicit r: Reads[T]): Reads[T]

    Permalink

    Reads a T at JsPath

    Reads a T at JsPath

    Definition Classes
    JsPath
  45. def readNullable[T](implicit r: Reads[T]): Reads[Option[T]]

    Permalink

    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 is 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
    JsPath
  46. def readNullableWithDefault[T](defaultValue: ⇒ Option[T])(implicit r: Reads[T]): Reads[Option[T]]

    Permalink

    Reads an Option[T] search optional or nullable field at JsPath (field not found replaced by default value, null is None and other cases are Error).

    Reads an Option[T] search optional or nullable field at JsPath (field not found replaced by default value, 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 is not found => returns default value
    • If last node is found with value "null" => returns None
    • If last node is found => applies implicit Reads[T]
    Definition Classes
    JsPath
  47. def readWithDefault[T](defaultValue: ⇒ T)(implicit r: Reads[T]): Reads[T]

    Permalink

    Reads a T at JsPath

    Reads a T at JsPath

    Definition Classes
    JsPath
  48. def rw[T](implicit r: Reads[T], w: Writes[T]): OFormat[T]

    Permalink

    Reads/Writes a T at JsPath using provided implicit Reads[T] and Writes[T]

    Reads/Writes a T at JsPath using provided implicit Reads[T] and Writes[T]

    Please note we couldn't call it "format" to prevent conflicts

    Definition Classes
    JsPath
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  50. def toJsonString: String

    Permalink
    Definition Classes
    JsPath
  51. def toString(): String

    Permalink
    Definition Classes
    JsPath → AnyRef → Any
  52. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def write[T](t: T)(implicit w: Writes[T]): OWrites[JsValue]

    Permalink

    Writes a pure value at given JsPath

    Writes a pure value at given JsPath

    Definition Classes
    JsPath
  56. def write[T](implicit w: Writes[T]): OWrites[T]

    Permalink

    Writes a T at given JsPath

    Writes a T at given JsPath

    Definition Classes
    JsPath
  57. def writeNullable[T](implicit w: Writes[T]): OWrites[Option[T]]

    Permalink

    Writes a Option[T] at given JsPath If None => doesn't write the field (never writes null actually) else => writes the field using implicit Writes[T]

    Writes a Option[T] at given JsPath If None => doesn't write the field (never writes null actually) else => writes the field using implicit Writes[T]

    Definition Classes
    JsPath

Inherited from JsPath

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped