play-json
API
Generated with
play-json/play.api.libs.json/JsPath

JsPath

play.api.libs.json.JsPath
See theJsPath companion object
case class JsPath(path: List[PathNode])

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

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object JsPath.type

Members list

Type members

Classlikes

object json

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
json.type

Value members

Concrete methods

def ++(other: JsPath): JsPath
def \(child: String): JsPath
def \(child: Symbol): JsPath
def \(idx: Int): JsPath
def \\(child: String): JsPath
def \\(child: Symbol): JsPath
def apply(idx: Int): JsPath
def apply(json: JsValue): List[JsValue]
def applyTillLast(json: JsValue): Either[JsError, JsResult[JsValue]]
def compose(other: JsPath): JsPath
def format[T](implicit f: Format[T]): OFormat[T]

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

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

Attributes

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]

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

Attributes

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]

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

Attributes

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

Attributes

See also

JsPath.readNullable to see behavior in reads

JsPath.writeNullable to see behavior in writes

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

Attributes

See also

JsPath.readNullableWithDefault to see behavior in reads

JsPath.writeNullable to see behavior in writes

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

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

Attributes

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

Attributes

See also

JsPath.lazyReadNullable to see behavior in reads

JsPath.lazyWriteNullable to see behavior in writes

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

Attributes

See also

JsPath.lazyReadNullable to see behavior in reads

JsPath.lazyWriteNullable to see behavior in writes

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

Attributes

See also

JsPath.lazyReadNullable to see behavior in reads

JsPath.lazyWriteNullable to see behavior in writes

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

Attributes

See also

JsPath.lazyReadNullable to see behavior in reads

JsPath.lazyWriteNullable to see behavior in writes

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.

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Reads, __ }

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

Attributes

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.

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Reads, __ }

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

Attributes

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

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Writes, __ }

case class User(id: Long, name: String, friend: User)

implicit lazy val UserWrites: Writes[User] = (
 (__ \ 'id).write[Long] and
 (__ \ 'name).write[String] and
 (__ \ 'friend).lazyWrite(UserWrites)
)(unlift(User.unapply))

Attributes

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

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Writes, __ }

case class User(id: Long, name: String, friend: Option[User])

implicit lazy val UserWrites: Writes[User] = (
 (__ \ 'id).write[Long] and
 (__ \ 'name).write[String] and
 (__ \ 'friend).lazyWriteNullable(UserWrites)
)(unlift(User.unapply))

Attributes

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

Simple Prune for simple path and only JsObject

Simple Prune for simple path and only JsObject

Attributes

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

Reads a T at JsPath

Reads a T at JsPath

Attributes

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

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

Attributes

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:

  • If any node in JsPath is not found => returns None
  • If any node in JsPath is found with value "null" => returns None
  • If the entire path is found => applies implicit Reads[T]

Attributes

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 any node in JsPath is not found => returns default value
  • If any node in JsPath is found with value "null" => returns None
  • If the entire path is found => applies implicit Reads[T]

Attributes

def readWithDefault[T](defaultValue: => T)(implicit r: Reads[T]): Reads[T]

Reads a T at JsPath

Reads a T at JsPath

Attributes

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

Attributes

def toJsonString: String
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def write[T](implicit w: Writes[T]): OWrites[T]

Writes a T at given JsPath

Writes a T at given JsPath

Attributes

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

Writes a pure value at given JsPath

Writes a pure value at given JsPath

Attributes

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]

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]

Attributes

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]

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

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with