trait ProfigPath extends ProfigPathPlatform
ProfigPath is the core of functionality in Profig. Profig extends from it for the root path and is used for looking up deeper paths as well.
- Alphabetic
- By Inheritance
- ProfigPath
- ProfigPathPlatform
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(): Json
Returns a Json representation of this path.
Returns a Json representation of this path. Works similar to
get(), except will return an empty Json object if there is nothing at this level.- returns
Json
- def apply(path: Path): ProfigPath
- def apply(path: String*): ProfigPath
Look up a deeper path below the current path.
Look up a deeper path below the current path.
- returns
ProfigPath
- def as[T](implicit arg0: Writer[T]): T
Loads this path out as the defined type
T.Loads this path out as the defined type
T.- T
the type to represent the current path
- returns
T
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asOr[T](default: => T)(implicit arg0: Writer[T]): T
Loads this path out as the defined type
T.Loads this path out as the defined type
T. If no value is set for this path, the default will be used.- T
the type to represent the current path
- default
the default to be used if this path is empty
- returns
T
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def exists(): Boolean
True if this path exists in the config
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(): Option[Json]
Returns a Json representation of this path if there is anything defined at this level.
Returns a Json representation of this path if there is anything defined at this level.
- returns
Option[Json]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def map(keys: (String, String)*): Unit
Maps from an existing key (if found) to a new key within this path.
Maps from an existing key (if found) to a new key within this path. This is sort of like aliasing from one key to a new key, but it will actually copy the values.
- keys
(from, to)
- def merge(json: Json, type: MergeType = MergeType.Overwrite): Unit
Merges a Json object to this path.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def opt[T](implicit arg0: Writer[T]): Option[T]
Convenience functionality similar to
asbut returns an option if set.Convenience functionality similar to
asbut returns an option if set.- T
the type to represent the current path
- returns
T
- def remove(): Unit
Removes this path
- def remove(field: String): Unit
Removes a field from this path.
Removes a field from this path.
- field
the field below this path to remove
- def store[T](value: T)(implicit arg0: Reader[T]): Unit
Stores the supplied value into this path.
Stores the supplied value into this path.
- T
the type of value
- value
the value to store
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()