Packages

  • package root

    JSON (JavaScript Object Notation) is a lightweight data-interchange format.

    JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages,

    JSON has only types of string, number, boolean, object, array, and null. This library includes additional types such as date, int, long, double, counter, binary, UUID, ObjectId (as in BSON), etc.

    It is very easy to parse a JSON object:

    val doc =
      json"""
      {
        "store": {
          "book": [
            {
              "category": "reference",
              "author": "Nigel Rees",
              "title": "Sayings of the Century",
              "price": 8.95
            },
            {
              "category": "fiction",
              "author": "Evelyn Waugh",
              "title": "Sword of Honour",
              "price": 12.99
            },
            {
              "category": "fiction",
              "author": "Herman Melville",
              "title": "Moby Dick",
              "isbn": "0-553-21311-3",
              "price": 8.99
            },
            {
              "category": "fiction",
              "author": "J. R. R. Tolkien",
              "title": "The Lord of the Rings",
              "isbn": "0-395-19395-8",
              "price": 22.99
            }
          ],
          "bicycle": {
            "color": "red",
            "price": 19.95
          }
        }
      }
      """

    The interpolator json parse a string to JsObject. To parse an array, use the interpolator jsan to JsArray. It is also okay to embed variable references directly in processed string literals.

    val x = 1
    json"""
      {
        "x": $x
      }
    """

    If the string is not a JSON object but any other valid JSON expression, one may use parseJson method to convert the string to a JsValue.

    "1".parseJson

    The json interpolator can only be applied to string literals. If you want to parse a string variable, the parseJson method can always be employed. If you know the string contains a JSON object, you may also use the method parseJsObject.

    val s = """{"x":1}"""
    s.parseJsObject

    To serialize a JSON value (of type JsValue) in compact mode, you can just use toString. To pretty print, use the method prettyPrint.

    doc.toString
    doc.prettyPrint

    With a JsObject or JsArray, you can refer to the individual elements with a variation of array syntax, like this:

    doc("store")("bicycle")("color")
    doc("store")("book")(0)("author")

    Note that we follow Scala's array access convention by () rather than [] in JavaScript.

    Besides, you can use the dot notation to access its fields/elements just like in JavaScript:

    doc.store.bicycle.color
    doc.store.book(0).author

    It is worth noting that we didn't define the type/schema of the document while Scala is a strong type language. In other words, we have both the type safe features of strong type language and the flexibility of dynamic language in this JSON library.

    If you try to access a non-exist field, JsUndefined is returned.

    scala> doc.book
    res11: unicorn.json.JsValue = undefined

    Although there are already several nice JSON libraries for Scala, the JSON objects are immutable by design, which is a natural choice for a functional language. For database, however, data mutation is necessary. Therefore, JsObject and JsArray are mutable data structures. You can set/add a field just like in JavaScript:

    json.store.bicycle.color = "green"

    To delete a field from JsObject, use remove method:

    doc.store.book(0) remove "price"

    It is same as setting it JsUndefined:

    doc.store.book(0).price = `JsUndefined`

    To delete an element from JsArray, the remove method will effectively remove it from the array. However, setting an element to undefined doesn't reduce the array size.

    // delete the first element and array size is smaller
    doc.store.book.remove(0)
    // set the first element to undefined but array size keeps same
    doc.store.book(0) = JsUndefined

    It is also possible to append an element or another array to JsArray:

    val a = JsArray(1, 2, 3, 4)
    a += 5
    
    a ++= JsArray(5, 6)

    Common iterative operations such as foreach, map, reduce can be applied to JsArray too.

    doc.store.book.asInstanceOf[JsArray].foreach { book =>
     println(book.price)
    }

    Because Scala is a static language, it is impossible to know doc.store.book is an array at compile time. So it is typed as generic JsValue, which is the parent type of specific JSON data types. Therefore, we use asInstanceOf[JsArray] to convert it to JsArray in order to use foreach.

    Definition Classes
    root
  • package smile
    Definition Classes
    root
  • package json

    Definition Classes
    smile
  • CompactPrinter
  • JsArray
  • JsBinary
  • JsBoolean
  • JsCounter
  • JsDate
  • JsDateTime
  • JsDecimal
  • JsDouble
  • JsInt
  • JsLong
  • JsNull
  • JsObject
  • JsObjectId
  • JsString
  • JsTime
  • JsTimestamp
  • JsUUID
  • JsUndefined
  • JsValue
  • JsValueOrdering
  • JsonHelper
  • JsonParser
  • JsonPrinter
  • JsonSerializer
  • ObjectId
  • ParserInput
  • PrettyPrinter

case class JsBoolean(value: Boolean) extends JsValue with Ordered[JsBoolean] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsBoolean
  2. Serializable
  3. Product
  4. Equals
  5. Ordered
  6. Comparable
  7. JsValue
  8. Dynamic
  9. AnyRef
  10. Any
Implicitly
  1. by json2Boolean
  2. by orderingToOrdered
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JsBoolean(value: Boolean)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def &(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Definition Classes
    Boolean
  4. def &&(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Definition Classes
    Boolean
  5. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JsBoolean toany2stringadd[JsBoolean] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  6. def ->[B](y: B): (JsBoolean, B)
    Implicit
    This member is added by an implicit conversion from JsBoolean toArrowAssoc[JsBoolean] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. def <(that: JsBoolean): Boolean
    Definition Classes
    Ordered
  8. def <=(that: JsBoolean): Boolean
    Definition Classes
    Ordered
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def >(that: JsBoolean): Boolean
    Definition Classes
    Ordered
  11. def >=(that: JsBoolean): Boolean
    Definition Classes
    Ordered
  12. def ^(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Definition Classes
    Boolean
  13. def apply(range: Range): JsArray
    Definition Classes
    JsValue
  14. def apply(start: Int, end: Int, step: Int): JsArray
    Definition Classes
    JsValue
  15. def apply(start: Int, end: Int): JsArray
    Definition Classes
    JsValue
  16. def apply(index: Int): JsValue
    Definition Classes
    JsValue
  17. def apply(key: String): JsValue
    Definition Classes
    JsValue
  18. def applyDynamic(key: String)(index: Int): JsValue
    Definition Classes
    JsValue
  19. def asBoolean: Boolean
    Definition Classes
    JsBooleanJsValue
  20. def asDate: LocalDate
    Definition Classes
    JsValue
  21. def asDateTime: LocalDateTime
    Definition Classes
    JsValue
  22. def asDecimal: BigDecimal
    Definition Classes
    JsValue
  23. def asDouble: Double
    Definition Classes
    JsBooleanJsValue
  24. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  25. def asInt: Int
    Definition Classes
    JsBooleanJsValue
  26. def asLong: Long
    Definition Classes
    JsBooleanJsValue
  27. def asTime: LocalTime
    Definition Classes
    JsValue
  28. def asTimestamp: Timestamp
    Definition Classes
    JsValue
  29. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  30. def compactPrint: String
    Definition Classes
    JsValue
  31. def compare(that: JsBoolean): Int
    Definition Classes
    JsBoolean → Ordered
  32. def compareTo(that: JsBoolean): Int
    Definition Classes
    Ordered → Comparable
  33. def ensuring(cond: (JsBoolean) => Boolean, msg: => Any): JsBoolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toEnsuring[JsBoolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  34. def ensuring(cond: (JsBoolean) => Boolean): JsBoolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toEnsuring[JsBoolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  35. def ensuring(cond: Boolean, msg: => Any): JsBoolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toEnsuring[JsBoolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  36. def ensuring(cond: Boolean): JsBoolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toEnsuring[JsBoolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(o: Any): Boolean
    Definition Classes
    JsBoolean → Equals → AnyRef → Any
  39. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  40. def get(key: String): Option[JsValue]
    Definition Classes
    JsValue
  41. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. def prettyPrint: String
    Definition Classes
    JsValue
  47. def productElementNames: Iterator[String]
    Definition Classes
    Product
  48. def remove(index: Int): JsValue
    Definition Classes
    JsValue
  49. def remove(key: String): Option[JsValue]
    Definition Classes
    JsValue
  50. def selectDynamic(key: String): JsValue
    Definition Classes
    JsValue
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String
    Definition Classes
    JsBooleanJsValue → AnyRef → Any
  53. def unary_!: Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Definition Classes
    Boolean
  54. def update(index: Int, value: JsValue): JsValue
    Definition Classes
    JsValue
  55. def update(key: String, value: JsValue): JsValue
    Definition Classes
    JsValue
  56. def updateDynamic(index: Int)(value: JsValue): JsValue
    Definition Classes
    JsValue
  57. def updateDynamic(key: String)(value: JsValue): JsValue
    Definition Classes
    JsValue
  58. val value: Boolean
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  62. def |(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Definition Classes
    Boolean
  63. def ||(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Definition Classes
    Boolean

Shadowed Implicit Value Members

  1. def !=(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Boolean).!=(x)
    Definition Classes
    Boolean
  2. def <(that: JsBoolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toOrdered[JsBoolean] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Ordered[JsBoolean]).<(that)
    Definition Classes
    Ordered
  3. def <=(that: JsBoolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toOrdered[JsBoolean] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Ordered[JsBoolean]).<=(that)
    Definition Classes
    Ordered
  4. def ==(x: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toBoolean performed by method json2Boolean in smile.json.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Boolean).==(x)
    Definition Classes
    Boolean
  5. def >(that: JsBoolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toOrdered[JsBoolean] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Ordered[JsBoolean]).>(that)
    Definition Classes
    Ordered
  6. def >=(that: JsBoolean): Boolean
    Implicit
    This member is added by an implicit conversion from JsBoolean toOrdered[JsBoolean] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Ordered[JsBoolean]).>=(that)
    Definition Classes
    Ordered
  7. def compare(that: JsBoolean): Int
    Implicit
    This member is added by an implicit conversion from JsBoolean toOrdered[JsBoolean] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Ordered[JsBoolean]).compare(that)
    Definition Classes
    Ordered
  8. def compareTo(that: JsBoolean): Int
    Implicit
    This member is added by an implicit conversion from JsBoolean toOrdered[JsBoolean] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (jsBoolean: Ordered[JsBoolean]).compareTo(that)
    Definition Classes
    Ordered → Comparable

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JsBoolean toStringFormat[JsBoolean] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (JsBoolean, B)
    Implicit
    This member is added by an implicit conversion from JsBoolean toArrowAssoc[JsBoolean] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[JsBoolean]

Inherited from Comparable[JsBoolean]

Inherited from JsValue

Inherited from Dynamic

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion json2Boolean fromJsBoolean to Boolean

Inherited by implicit conversion orderingToOrdered fromJsBoolean to Ordered[JsBoolean]

Inherited by implicit conversion any2stringadd fromJsBoolean to any2stringadd[JsBoolean]

Inherited by implicit conversion StringFormat fromJsBoolean to StringFormat[JsBoolean]

Inherited by implicit conversion Ensuring fromJsBoolean to Ensuring[JsBoolean]

Inherited by implicit conversion ArrowAssoc fromJsBoolean to ArrowAssoc[JsBoolean]

Ungrouped