play.api.libs.json

JsPath

case class JsPath(path: List[PathNode] = immutable.this.Nil) extends Product with Serializable

Path to a JsValue; As for path to file on FS, there may not be any matching value in the parsed JSON.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
JsPath
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JsPath
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JsPath(path: List[PathNode] = immutable.this.Nil)

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. def ++(other: JsPath): JsPath

  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  7. def \(idx: Int): JsPath

  8. def \(child: Symbol): JsPath

  9. def \(child: String): JsPath

  10. def \\(child: Symbol): JsPath

  11. def \\(child: String): JsPath

  12. def apply(json: JsValue): List[JsValue]

  13. def apply(idx: Int): JsPath

  14. def applyTillLast(json: JsValue): Either[JsError, JsResult[JsValue]]

  15. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  16. def asSingleJsResult(json: JsValue): JsResult[JsValue]

  17. def asSingleJson(json: JsValue): JsLookupResult

  18. def clone(): AnyRef

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

  19. def compose(other: JsPath): JsPath

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

    Definition Classes
    AnyRef

  21. def format[T](w: Writes[T])(implicit r: Reads[T]): OFormat[T]

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

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

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

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

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

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

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

    Reads/Writes a Option[T] (optional or nullable field) at given 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]]

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

    Reads/Writes a Option[T] (nullable field) at given 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]

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

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

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  29. object json

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

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

    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]

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

    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]]

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

    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]]

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

    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]

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

  35. def lazyReadNullable[T](r: ⇒ Reads[T]): Reads[Option[T]]

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

  36. def lazyWrite[T](w: ⇒ Writes[T]): OWrites[T]

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

  37. def lazyWriteNullable[T](w: ⇒ Writes[T]): OWrites[Option[T]]

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

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

    Definition Classes
    AnyRef

  39. final def notify(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  41. val path: List[PathNode]

  42. def prune(js: JsValue): JsResult[JsObject]

    Simple Prune for simple path and only JsObject

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

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

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

    Reads a T at JsPath

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

    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]

  46. def readNullableWithDefault[T](defaultValue: ⇒ Option[T])(implicit r: Reads[T]): Reads[Option[T]]

    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]

  47. def readWithDefault[T](defaultValue: ⇒ T)(implicit r: Reads[T]): Reads[T]

    Reads a T at JsPath

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

    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

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

    Definition Classes
    AnyRef

  50. def toJsonString: String

  51. def toString(): String

    Definition Classes
    JsPath → AnyRef → Any

  52. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  55. def write[T](t: T)(implicit w: Writes[T]): OWrites[JsValue]

    Writes a pure value at given JsPath

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

    Writes a T at given JsPath

  57. def writeNullable[T](implicit w: Writes[T]): OWrites[Option[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]

  58. def writeOptionWithNull[T](implicit w: Writes[T]): OWrites[Option[T]]

    Writes a Option[T] at given JsPath If None => writes 'null' else => writes the field using implicit Writes[T]

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 Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped