JsPath

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. def ++(other: JsPath): JsPath

   

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

   

   Definition Classes

   AnyRef → Any

5. def \(child: Symbol): JsPath

   

6. def \(child: String): JsPath

   

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

   

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

   

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

   

10. def apply(idx: Int): JsPath

    

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

    

12. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

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

    

14. def asSingleJson(json: JsValue): JsLookupResult

    

15. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

16. def compose(other: JsPath): JsPath

    

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

    

    Definition Classes

    AnyRef

18. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

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

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

    

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

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

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

    

    Definition Classes

    AnyRef → Any

24. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

25. object json

    

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

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

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

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

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

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

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

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

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

    

    Definition Classes

    AnyRef

35. final def notify(): Unit

    

    Definition Classes

    AnyRef

36. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

37. val path: List[PathNode]

    

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

    

    Simple Prune for simple path and only JsObject

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

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

    

    Reads a T at JsPath

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

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

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

    

    Definition Classes

    AnyRef

44. def toJsonString: String

    

45. def toString(): String

    

    Definition Classes

    JsPath → AnyRef → Any

46. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Writes a pure value at given JsPath

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

    

    Writes a T at given JsPath

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