fabric-core/fabric/Str

Str

final case class Str(value: String) extends AnyVal with Json

Str represents a String

Companion:
object
Source:
Json.scala
trait Product
trait Equals
trait Json
class AnyVal
trait Matchable
class Any

Type members

Types

override type Type = Str
Source:
Json.scala

Value members

Concrete methods

override def `type`: JsonType[Str]

The type of value

The type of value

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

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

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

Definition Classes
Source:
Json.scala
override def isEmpty: Boolean
Definition Classes
Source:
Json.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
Any
Source:
Json.scala

Inherited methods

final def apply(path: Path): Json

Looks up a Json based on Path

Looks up a Json based on Path

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

Inherited from:
Json
Source:
Json.scala
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

Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
def asBigDecimal: BigDecimal

Convenience method for asNum.value

Convenience method for asNum.value

Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
def asBoolean: Boolean

Convenience method for asBool.value

Convenience method for asBool.value

Inherited from:
Json
Source:
Json.scala
def asByte: Byte
Inherited from:
Json
Source:
Json.scala
def asDouble: Double
Inherited from:
Json
Source:
Json.scala
def asFloat: Float
Inherited from:
Json
Source:
Json.scala
def asInt: Int
Inherited from:
Json
Source:
Json.scala
def asLong: Long
Inherited from:
Json
Source:
Json.scala
def asMap: ListMap[String, Json]

Convenience method for asObj.value

Convenience method for asObj.value

Inherited from:
Json
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

Inherited from:
Json
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

Inherited from:
Json
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

Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
def asShort: Short
Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
def asString: String

Convenience method for asStr.value

Convenience method for asStr.value

Inherited from:
Json
Source:
Json.scala
def asVector: Vector[Json]

Convenience method for asArr.value

Convenience method for asArr.value

Inherited from:
Json
Source:
Json.scala
def filter(filter: ValueFilter): 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

Returns:

Option[Json]

Inherited from:
Json
Source:
Json.scala
final def get(path: Path): 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")

Inherited from:
Json
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.

Inherited from:
Json
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

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

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

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.

Returns:

Option[V]

Inherited from:
Json
Source:
Json.scala
def getBigDecimal: Option[BigDecimal]

Convenience method for getNum.map(_.value)

Convenience method for getNum.map(_.value)

Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
def getBoolean: Option[Boolean]

Convenience method for getBool.map(_.value)

Convenience method for getBool.map(_.value)

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

Convenience method for getObj.map(_.value)

Convenience method for getObj.map(_.value)

Inherited from:
Json
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

Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
final def getOrCreate(lookup: String): 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.

Inherited from:
Json
Source:
Json.scala
def getShort: Option[Short]
Inherited from:
Json
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

Inherited from:
Json
Source:
Json.scala
def getString: Option[String]

Convenience method for getStr.map(_.value)

Convenience method for getStr.map(_.value)

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

Convenience method for getArr.map(_.value)

Convenience method for getArr.map(_.value)

Inherited from:
Json
Source:
Json.scala
def isArr: Boolean

True if this is an Arr

True if this is an Arr

Inherited from:
Json
Source:
Json.scala
def isBool: Boolean

True if this is a Bool

True if this is a Bool

Inherited from:
Json
Source:
Json.scala
def isNull: Boolean

True if this is a Null

True if this is a Null

Inherited from:
Json
Source:
Json.scala
def isNum: Boolean

True if this is a Num

True if this is a Num

Inherited from:
Json
Source:
Json.scala
def isNumDec: Boolean
Inherited from:
Json
Source:
Json.scala
def isNumInt: Boolean
Inherited from:
Json
Source:
Json.scala
def isObj: Boolean

True if this is an Obj

True if this is an Obj

Inherited from:
Json
Source:
Json.scala
def isStr: Boolean

True if this is a Str

True if this is a Str

Inherited from:
Json
Source:
Json.scala
final def merge(value: Json, path: Path, 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

Returns:

root Json after merge

Inherited from:
Json
Source:
Json.scala
def modify(path: Path)(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

Returns:

new root Json representing the changes

Inherited from:
Json
Source:
Json.scala
def nonEmpty: Boolean
Inherited from:
Json
Source:
Json.scala
def productIterator: Iterator[Any]
Inherited from:
Product
def remove(path: Path): 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

Returns:

new root Json representing the changes

Inherited from:
Json
Source:
Json.scala
def set(path: Path, 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

Returns:

new root Json representing the changes

Inherited from:
Json
Source:
Json.scala