profig/profig/ProfigPath

ProfigPath

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.

Companion:
object
class Object
trait Matchable
class Any
class Profig
object Profig.type

Value members

Abstract methods

def path: Path

Concrete methods

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 apply(path: Path): ProfigPath
def apply(): Value

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.

Returns:

Json

def as[T : Writer]: T

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

Returns:

T

def asOr[T : Writer](default: => T): 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

Returns:

T

def exists(): Boolean

True if this path exists in the config

True if this path exists in the config

def get(): Option[Value]

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]

def merge(json: Value, `type`: MergeType): Unit

Merges a Json object to this path.

Merges a Json object to this path.

def opt[T : Writer]: Option[T]

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

Returns:

T

def remove(field: String): Unit

Removes a field from this path.

Removes a field from this path.

Value parameters:
field

the field below this path to remove

def remove(): Unit
def store[T : Reader](value: T): Unit

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

Inherited methods

def initConfiguration(startPath: Path, additionalPaths: List[Path], recursiveParents: Boolean, includeClassPath: Boolean, fileNameMatcher: FileNameMatcher, errorHandler: Option[Throwable => Unit]): Unit
Inherited from:
ProfigPathPlatform
def load(fileName: String, source: Source, mergeType: MergeType, errorHandler: Option[Throwable => Unit]): Unit
Inherited from:
ProfigPathPlatform
def loadConfiguration(startPath: Path, additionalPaths: List[Path], recursiveParents: Boolean, includeClassPath: Boolean, fileNameMatcher: FileNameMatcher, errorHandler: Option[Throwable => Unit]): Unit
Inherited from:
ProfigPathPlatform
def loadFile(file: File, mergeType: MergeType, errorHandler: Option[Throwable => Unit]): Unit
Inherited from:
ProfigPathPlatform