fabric-core
1.14.2
API
Generated with
fabric-core/fabric/Json

Json

fabric.Json
See theJson companion object
sealed trait Json

Json represents the base sealed trait for all representable types in Fabric.

Attributes

Companion
object
Source
Json.scala
Graph
Supertypes
class Any
Known subtypes
class Arr
class Bool
trait Null
object Null
trait Num
class NumDec
class NumInt
class Obj
class Str
Show all

Members list

Type members

Types

type Type

Attributes

Source
Json.scala

Value members

Abstract methods

def `type`: JsonType[Type]

The type of value

The type of value

Attributes

Source
Json.scala
def genKey(b: StringBuilder): Unit

Generates a consistent key from this JSON.

Generates a consistent key from this JSON. This can be useful for comparison or unique reference.

Attributes

Source
Json.scala
def isEmpty: Boolean

Attributes

Source
Json.scala
def reference: Option[Any]

Reference allows the reference for this Json to be included to provide additional information.

Reference allows the reference for this Json to be included to provide additional information.

Attributes

Source
Json.scala

Concrete methods

final def apply(lookup: String): Json

Looks up a Json by name in the children.

Looks up a Json by name in the children.

Throws an exception if invoked on anything except Obj

Attributes

Source
Json.scala
final def apply(path: JsonPath): Json

Looks up a Json based on Path

Looks up a Json based on Path

Example: val v = someValue("first" \ "second" \ "third")

Attributes

Source
Json.scala
def asArr: Arr

Casts to Arr or throws an exception if not an Arr

Casts to Arr or throws an exception if not an Arr

Attributes

Source
Json.scala
def asBigDecimal: BigDecimal

Convenience method for asNum.value

Convenience method for asNum.value

Attributes

Source
Json.scala
def asBool: Bool

Casts to Bool or throws an exception if not a Bool

Casts to Bool or throws an exception if not a Bool

Attributes

Source
Json.scala
def asBoolean: Boolean

Convenience method for asBool.value

Convenience method for asBool.value

Attributes

Source
Json.scala
def asByte: Byte

Attributes

Source
Json.scala
def asDouble: Double

Attributes

Source
Json.scala
def asFloat: Float

Attributes

Source
Json.scala
def asInt: Int

Attributes

Source
Json.scala
def asLong: Long

Attributes

Source
Json.scala
def asMap: Map[String, Json]

Convenience method for asObj.value

Convenience method for asObj.value

Attributes

Source
Json.scala
def asNum: Num

Casts to Num or throws an exception if not a Num

Casts to Num or throws an exception if not a Num

Attributes

Source
Json.scala
def asNumDec: NumDec

Casts to NumDec or throws an exception if not a NumDec

Casts to NumDec or throws an exception if not a NumDec

Attributes

Source
Json.scala
def asNumInt: NumInt

Casts to NumInt or throws an exception if not a NumInt

Casts to NumInt or throws an exception if not a NumInt

Attributes

Source
Json.scala
def asObj: Obj

Casts to Obj or throws an exception if not an Obj

Casts to Obj or throws an exception if not an Obj

Attributes

Source
Json.scala
def asShort: Short

Attributes

Source
Json.scala
def asStr: Str

Casts to Str or throws an exception if not a Str

Casts to Str or throws an exception if not a Str

Attributes

Source
Json.scala
def asString: String

Convenience method for asStr.value

Convenience method for asStr.value

Attributes

Source
Json.scala
def asType[V <: Json](`type`: JsonType[V]): V

Safely casts this Json as the specified JsonType.

Safely casts this Json as the specified JsonType. Throws an exception if not a match.

Type parameters

V

the return type

Value parameters

`type`

the type to cast this JsonType as

Attributes

Source
Json.scala
def asVector: Vector[Json]

Convenience method for asArr.value

Convenience method for asArr.value

Attributes

Source
Json.scala
final def filter(filter: JsonFilter): Option[Json]

Applies the filter recursively to this value beginning on the leafs working backward up the tree back to the root.

Applies the filter recursively to this value beginning on the leafs working backward up the tree back to the root.

Value parameters

filter

the filter to apply

Attributes

Returns

Option[Json]

Source
Json.scala
final def filterOne(filter: JsonFilter): Json

Attributes

Source
Json.scala
final def get(lookup: String): Option[Json]

Looks up a Json by name in the children.

Looks up a Json by name in the children.

Attributes

Source
Json.scala
final def get(lookup: JsonPathEntry): Option[Json]

Attributes

Source
Json.scala
final def get(path: JsonPath): Option[Json]

Looks up a Json based on Path

Looks up a Json based on Path

Example: val o: Option[Json] = someValue("first" \ "second" \ "third")

Attributes

Source
Json.scala
def getArr: Option[Arr]

Casts to Arr if it's of Arr type or returns None

Casts to Arr if it's of Arr type or returns None

Attributes

Source
Json.scala
final def getAsType[V <: Json](`type`: JsonType[V]): Option[V]

Safely casts this Json as the specified JsonType.

Safely casts this Json as the specified JsonType. Returns None if it's a different type.

Type parameters

V

the value type

Value parameters

`type`

the value type of value you want.

Attributes

Returns

Option[V]

Source
Json.scala
def getBigDecimal: Option[BigDecimal]

Convenience method for getNum.map(_.value)

Convenience method for getNum.map(_.value)

Attributes

Source
Json.scala
def getBool: Option[Bool]

Casts to Bool if it's of Bool type or returns None

Casts to Bool if it's of Bool type or returns None

Attributes

Source
Json.scala
def getBoolean: Option[Boolean]

Convenience method for getBool.map(_.value)

Convenience method for getBool.map(_.value)

Attributes

Source
Json.scala
def getByte: Option[Byte]

Attributes

Source
Json.scala
def getDouble: Option[Double]

Attributes

Source
Json.scala
def getFloat: Option[Float]

Attributes

Source
Json.scala
def getInt: Option[Int]

Attributes

Source
Json.scala
def getLong: Option[Long]

Attributes

Source
Json.scala
def getMap: Option[Map[String, Json]]

Convenience method for getObj.map(_.value)

Convenience method for getObj.map(_.value)

Attributes

Source
Json.scala
def getNum: Option[Num]

Casts to Num if it's of Num type or returns None

Casts to Num if it's of Num type or returns None

Attributes

Source
Json.scala
def getObj: Option[Obj]

Casts to Obj if it's of Obj type or returns None

Casts to Obj if it's of Obj type or returns None

Attributes

Source
Json.scala
final def getOrCreate(lookup: JsonPathEntry): Json

Looks up a Json by name in the children or creates a new Obj if it doesn't exist.

Looks up a Json by name in the children or creates a new Obj if it doesn't exist.

Attributes

Source
Json.scala
def getShort: Option[Short]

Attributes

Source
Json.scala
def getStr: Option[Str]

Casts to Str if it's of Str type or returns None

Casts to Str if it's of Str type or returns None

Attributes

Source
Json.scala
def getString: Option[String]

Convenience method for getStr.map(_.value)

Convenience method for getStr.map(_.value)

Attributes

Source
Json.scala
def getVector: Option[Vector[Json]]

Convenience method for getArr.map(_.value)

Convenience method for getArr.map(_.value)

Attributes

Source
Json.scala
def isArr: Boolean

True if this is an Arr

True if this is an Arr

Attributes

Source
Json.scala
def isBool: Boolean

True if this is a Bool

True if this is a Bool

Attributes

Source
Json.scala
def isNull: Boolean

True if this is a Null

True if this is a Null

Attributes

Source
Json.scala
def isNum: Boolean

True if this is a Num

True if this is a Num

Attributes

Source
Json.scala
def isNumDec: Boolean

Attributes

Source
Json.scala
def isNumInt: Boolean

Attributes

Source
Json.scala
def isObj: Boolean

True if this is an Obj

True if this is an Obj

Attributes

Source
Json.scala
def isStr: Boolean

True if this is a Str

True if this is a Str

Attributes

Source
Json.scala
final def merge(value: Json, path: JsonPath, config: MergeConfig): Json

Merges a Json at the specified path

Merges a Json at the specified path

Value parameters

config

the merge configuration (defaults to MergeConfig)

path

the path (defaults to Path.empty)

value

the value to merge

Attributes

Returns

root Json after merge

Source
Json.scala
def modify(path: JsonPath)(f: Json => Json): Json

Modifies the value at the specified path and returns back a new root Json with the modified path.

Modifies the value at the specified path and returns back a new root Json with the modified path.

Note: We use the term "modify" here from an immutable standpoint. The original Json will not change.

Value parameters

f

the function that takes the current Json and returns the modified Json

path

the path to modify

Attributes

Returns

new root Json representing the changes

Source
Json.scala
def nonEmpty: Boolean

Attributes

Source
Json.scala
def remove(path: JsonPath): Json

Convenience functionality for #modify to remove the value at a specific path.

Convenience functionality for #modify to remove the value at a specific path.

Value parameters

path

the path to remove

Attributes

Returns

new root Json representing the changes

Source
Json.scala
def search(entries: SearchEntry*): List[JsonPath]

Attributes

Source
Json.scala
def set(path: JsonPath, value: Json): Json

Convenience functionality for #modify to set a specific value at a path.

Convenience functionality for #modify to set a specific value at a path.

Value parameters

path

the path to replace

value

the new value to set

Attributes

Returns

new root Json representing the changes

Source
Json.scala
def toKey: String

Generates a consistent key from this JSON.

Generates a consistent key from this JSON. This can be useful for comparison or unique reference. Convenience wrapper for genKey.

Attributes

Source
Json.scala
def transform(search: Search): Transformer

Attributes

Source
Json.scala
Generated with