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.
Attributes
- Companion
- object
- Graph
-
- Supertypes
- Known subtypes
Members list
Value members
Concrete methods
Look up a deeper path below the current path.
Look up a deeper path below the current path.
Attributes
- Returns
-
ProfigPath
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 a Json representation of this path. Works similar to get(), except will return an empty Json object if there is nothing at this level.
Attributes
- Returns
-
Json
Loads this path out as the defined type T.
Loads this path out as the defined type T.
Type parameters
- T
-
the type to represent the current path
Attributes
- Returns
-
T
Loads this path out as the defined type T. If no value is set for this path, the default will be used.
Loads this path out as the defined type T. If no value is set for this path, the default will be used.
Type parameters
- T
-
the type to represent the current path
Value parameters
- default
-
the default to be used if this path is empty
Attributes
- Returns
-
T
True if this path exists in the config
True if this path exists in the config
Attributes
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.
Attributes
- Returns
-
Option[Json]
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.
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.
Value parameters
- keys
-
(from, to)
Attributes
Merges a Json object to this path.
Merges a Json object to this path.
Attributes
Convenience functionality similar to as but returns an option if set.
Convenience functionality similar to as but returns an option if set.
Type parameters
- T
-
the type to represent the current path
Attributes
- Returns
-
T
Removes a field from this path.
Removes a field from this path.
Value parameters
- field
-
the field below this path to remove
Attributes
Removes this path
Removes this path
Attributes
Stores the supplied value into this path.
Stores the supplied value into this path.
Type parameters
- T
-
the type of value
Value parameters
- value
-
the value to store
Attributes
Inherited methods
Attributes
- Inherited from:
- ProfigPathPlatform
Attributes
- Inherited from:
- ProfigPathPlatform
Attributes
- Inherited from:
- ProfigPathPlatform
Attributes
- Inherited from:
- ProfigPathPlatform