Null

object Null extends Null

Null represents a null Value

Companion
class
trait Sum
trait Mirror
trait Null
trait Value
class Object
trait Matchable
class Any

Type members

Types

override
type Type = Null

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from
Mirror

Value members

Concrete methods

override
Definition Classes
override
def isEmpty: Boolean
Definition Classes
override
def toString: String
Definition Classes
Any

Inherited methods

final
def apply(path: Path): Value

Looks up a Value based on Path

Looks up a Value based on Path

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

Inherited from
Value
final
def apply(lookup: String): Value

Looks up a Value by name in the children.

Looks up a Value by name in the children.

Throws an exception if invoked on anything except Obj

Inherited from
Value
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

Inherited from
Value
def asBigDecimal: BigDecimal

Convenience method for asNum.value

Convenience method for asNum.value

Inherited from
Value

Casts to Bool or throws an exception if not a Bool

Casts to Bool or throws an exception if not a Bool

Inherited from
Value
def asBoolean: Boolean

Convenience method for asBool.value

Convenience method for asBool.value

Inherited from
Value
def asByte: Byte
Inherited from
Value
def asDouble: Double
Inherited from
Value
def asFloat: Float
Inherited from
Value
def asInt: Int
Inherited from
Value
def asLong: Long
Inherited from
Value
def asMap: Map[String, Value]

Convenience method for asObj.value

Convenience method for asObj.value

Inherited from
Value
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

Inherited from
Value

Casts to NumDec or throws an exception if not a NumDec

Casts to NumDec or throws an exception if not a NumDec

Inherited from
Value

Casts to NumInt or throws an exception if not a NumInt

Casts to NumInt or throws an exception if not a NumInt

Inherited from
Value
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

Inherited from
Value
def asShort: Short
Inherited from
Value
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

Inherited from
Value
def asString: String

Convenience method for asStr.value

Convenience method for asStr.value

Inherited from
Value
def asValue[V <: Value](`type`: ValueType[V]): V

Safely casts this Value as the specified ValueType. Throws an exception if not a match.

Safely casts this Value as the specified ValueType. Throws an exception if not a match.

Type Params
V

the return type

Value Params
`type`

the type to cast this ValueType as

Inherited from
Value
def asVector: Vector[Value]

Convenience method for asArr.value

Convenience method for asArr.value

Inherited from
Value
def filter(filter: ValueFilter): Option[Value]

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 Params
filter

the filter to apply

Returns

Option[Value]

Inherited from
Value
final
def get(path: Path): Option[Value]

Looks up a Value based on Path

Looks up a Value based on Path

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

Inherited from
Value
final
def get(lookup: String): Option[Value]

Looks up a Value by name in the children.

Looks up a Value by name in the children.

Inherited from
Value
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

Inherited from
Value
def getBigDecimal: Option[BigDecimal]

Convenience method for getNum.map(_.value)

Convenience method for getNum.map(_.value)

Inherited from
Value
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

Inherited from
Value
def getBoolean: Option[Boolean]

Convenience method for getBool.map(_.value)

Convenience method for getBool.map(_.value)

Inherited from
Value
def getByte: Option[Byte]
Inherited from
Value
def getDouble: Option[Double]
Inherited from
Value
def getFloat: Option[Float]
Inherited from
Value
def getInt: Option[Int]
Inherited from
Value
def getLong: Option[Long]
Inherited from
Value
def getMap: Option[Map[String, Value]]

Convenience method for getObj.map(_.value)

Convenience method for getObj.map(_.value)

Inherited from
Value
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

Inherited from
Value
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

Inherited from
Value
final
def getOrCreate(lookup: String): Value

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

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

Inherited from
Value
def getShort: Option[Short]
Inherited from
Value
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

Inherited from
Value
def getString: Option[String]

Convenience method for getStr.map(_.value)

Convenience method for getStr.map(_.value)

Inherited from
Value
final
def getValue[V <: Value](`type`: ValueType[V]): Option[V]

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

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

Type Params
V

the value type

Value Params
`type`

the value type of value you want.

Returns

Option[V]

Inherited from
Value
def getVector: Option[Vector[Value]]

Convenience method for getArr.map(_.value)

Convenience method for getArr.map(_.value)

Inherited from
Value
def isArr: Boolean

True if this is an Arr

True if this is an Arr

Inherited from
Value
def isBool: Boolean

True if this is a Bool

True if this is a Bool

Inherited from
Value
def isNull: Boolean

True if this is a Null

True if this is a Null

Inherited from
Value
def isNum: Boolean

True if this is a Num

True if this is a Num

Inherited from
Value
def isNumDec: Boolean
Inherited from
Value
def isNumInt: Boolean
Inherited from
Value
def isObj: Boolean

True if this is an Obj

True if this is an Obj

Inherited from
Value
def isStr: Boolean

True if this is a Str

True if this is a Str

Inherited from
Value
def merge(value: Value, path: Path, `type`: MergeType): Value

Merges a Value at the specified path

Merges a Value at the specified path

Value Params
`type`

the merge type (defaults to MergeType.Overwrite)

path

the path (defaults to Path.empty)

value

the value to merge

Returns

root Value after merge

Inherited from
Value
def modify(path: Path)(f: Value => Value): Value

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

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

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

Value Params
f

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

path

the path to modify

Returns

new root Value representing the changes

Inherited from
Value
def nonEmpty: Boolean
Inherited from
Value
def remove(path: Path): Value

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 Params
path

the path to remove

Returns

new root Value representing the changes

Inherited from
Value
def set(path: Path, value: Value): Value

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 Params
path

the path to replace

value

the new value to set

Returns

new root Value representing the changes

Inherited from
Value