final case class Str(value: String) extends AnyVal with Value with Product with Serializable
Str represents a String
- Alphabetic
- By Inheritance
- Str
- Serializable
- Product
- Equals
- Value
- AnyVal
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Str(value: String)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##: Int
- Definition Classes
- Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- 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")
- Definition Classes
- 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
- Definition Classes
- 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
- Definition Classes
- Value
- 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
- Definition Classes
- Value
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- Definition Classes
- 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
- Definition Classes
- 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
- Definition Classes
- Value
- def asValue[V <: Value](type: ValueType): V
Safely casts this Value as the specified ValueType.
Safely casts this Value as the specified ValueType. Throws an exception if not a match.
- V
the return type
- Definition Classes
- 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")
- Definition Classes
- 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.
- Definition Classes
- Value
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- 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.
- Definition Classes
- Value
- def isArr: Boolean
True if this is an Arr
True if this is an Arr
- Definition Classes
- Value
- def isBool: Boolean
True if this is a Bool
True if this is a Bool
- Definition Classes
- Value
- def isEmpty: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNull: Boolean
True if this is a Null
True if this is a Null
- Definition Classes
- Value
- def isNum: Boolean
True if this is a Num
True if this is a Num
- Definition Classes
- Value
- def isObj: Boolean
True if this is an Obj
True if this is an Obj
- Definition Classes
- Value
- def isStr: Boolean
True if this is a Str
True if this is a Str
- Definition Classes
- Value
- def merge(value: Value, path: Path = Path.empty, type: MergeType = MergeType.Overwrite): Value
Merges a Value at the specified path
Merges a Value at the specified path
- value
the value to merge
- path
the path (defaults to Path.empty)
- returns
root Value after merge
- Definition Classes
- 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.
- path
the path to modify
- f
the function that takes the current Value and returns the modified Value
- returns
new root Value representing the changes
- Definition Classes
- Value
- def nonEmpty: Boolean
- Definition Classes
- Value
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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.
- path
the path to remove
- returns
new root Value representing the changes
- Definition Classes
- 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.
- path
the path to replace
- value
the new value to set
- returns
new root Value representing the changes
- Definition Classes
- Value
- def toString(): String
- Definition Classes
- Str → Any
- def type: ValueType
The type of value
- val value: String