Packages

object OWrites extends PathWrites with ConstraintWrites

Source
Writes.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OWrites
  2. ConstraintWrites
  3. PathWrites
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 apply[A](f: (A) => JsObject): OWrites[A]

    Returns an instance which uses f as OWrites.writes function.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def at[A](path: JsPath)(implicit wrs: Writes[A]): OWrites[A]
    Definition Classes
    PathWrites
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. implicit val contravariantfunctorOWrites: ContravariantFunctor[OWrites]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. implicit val functionalCanBuildOWrites: FunctionalCanBuild[OWrites]
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def jsPick(path: JsPath): Writes[JsValue]
    Definition Classes
    PathWrites
  16. def jsPickBranch(path: JsPath): OWrites[JsValue]
    Definition Classes
    PathWrites
  17. def jsPickBranchUpdate(path: JsPath, wrs: OWrites[JsValue]): OWrites[JsValue]
    Definition Classes
    PathWrites
  18. def list[A](implicit writes: Writes[A]): Writes[List[A]]
    Definition Classes
    ConstraintWrites
  19. def map[A](implicit writes: Writes[A]): OWrites[Map[String, A]]
    Definition Classes
    ConstraintWrites
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def nullable[A](path: JsPath)(implicit wrs: Writes[A]): OWrites[Option[A]]

    writes a optional field in given JsPath : if None, doesn't write field at all.

    writes a optional field in given JsPath : if None, doesn't write field at all. Please note we do not write "null" but simply omit the field when None If you want to write a "null", use ConstraintWrites.optionWithNull[A]

    Definition Classes
    PathWrites
  24. def of[A](implicit w: OWrites[A]): OWrites[A]
  25. def of[A](implicit w: Writes[A]): Writes[A]
    Definition Classes
    ConstraintWrites
  26. def optionWithNull[A](implicit wa: Writes[A]): Writes[Option[A]]

    Pure Option Writer[T] which writes "null" when None which is different from JsPath.writeNullable which omits the field when None

    Pure Option Writer[T] which writes "null" when None which is different from JsPath.writeNullable which omits the field when None

    Definition Classes
    ConstraintWrites
  27. def pruned[A]: Writes[A]
    Definition Classes
    ConstraintWrites
  28. def pure[A](fixed: => A)(implicit wrs: OWrites[A]): OWrites[JsValue]
  29. def pure[A](fixed: => A)(implicit wrs: Writes[A]): Writes[JsValue]
    Definition Classes
    ConstraintWrites
  30. def pure[A](path: JsPath, fixed: => A)(implicit wrs: Writes[A]): OWrites[JsValue]
    Definition Classes
    PathWrites
  31. def seq[A](implicit writes: Writes[A]): Writes[Seq[A]]
    Definition Classes
    ConstraintWrites
  32. def set[A](implicit writes: Writes[A]): Writes[Set[A]]
    Definition Classes
    ConstraintWrites
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. def transform[A](w: OWrites[A])(f: (A, JsObject) => JsObject): OWrites[A]

    Transforms the resulting JsObject using the given function, which is also applied with the initial input.

    Transforms the resulting JsObject using the given function, which is also applied with the initial input.

    w

    the initial writer

    f

    the transformer function

  36. def tuple2[A, B](name1: String, name2: String)(implicit arg0: Writes[A], arg1: Writes[B]): OWrites[(A, B)]

    Writes a tuple of two values to a JSON object, with custom field names.

    Writes a tuple of two values to a JSON object, with custom field names.

    A

    the type of the first value

    B

    the type of the second value

    val tuple2Writes: OWrites[(String, Int)] =
      OWrites.tuple2[String, Int]("name", "age")
    
    tuple2Writes.writes("Bob" -> 30) // {"name":"Bob","age":30}
    name1

    the name of the first field

    name2

    the name of the second field

  37. def tuple3[A, B, C](name1: String, name2: String, name3: String)(implicit arg0: Writes[A], arg1: Writes[B], arg2: Writes[C]): OWrites[(A, B, C)]

    Writes a tuple of three values to a JSON object, with custom field names.

    Writes a tuple of three values to a JSON object, with custom field names.

    A

    the type of the first value

    B

    the type of the second value

    C

    the type of the third value

    val tuple3Writes: OWrites[(String, Int, Boolean)] =
      OWrites.tuple3[String, Int, Boolean]("name", "age", "isStudent")
    
    tuple3Writes.writes(("Bob", 30, false))
    // {"name":"Bob","age":30,"isStudent":false}
    name1

    the name of the first field

    name2

    the name of the second field

    name3

    the name of the third field

  38. def tuple4[A, B, C, D](name1: String, name2: String, name3: String, name4: String)(implicit arg0: Writes[A], arg1: Writes[B], arg2: Writes[C], arg3: Writes[D]): OWrites[(A, B, C, D)]

    Writes a tuple of four values to a JSON object, with custom field names.

    Writes a tuple of four values to a JSON object, with custom field names.

    A

    the type of the first value

    B

    the type of the second value

    C

    the type of the third value

    D

    the type of the fourth value

    val tuple4Writes: OWrites[(String, Int, Boolean, Double)] =
      OWrites.tuple4[String, Int, Boolean, Double]("name", "age", "isStudent", "score")
    
    tuple4Writes.writes(("Bob", 30, false, 91.2))
    // {"name":"Bob","age":30,"isStudent":false,"score":91.2}
    name1

    the name of the first field

    name2

    the name of the second field

    name3

    the name of the third field

    name4

    the name of the fourth field

  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def pruned[A](implicit w: Writes[A]): Writes[A]
    Definition Classes
    ConstraintWrites
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) Use pruned without Writes[A]

Inherited from ConstraintWrites

Inherited from PathWrites

Inherited from AnyRef

Inherited from Any

Ungrouped