profig/profig/Profig

Profig

class Profig extends ProfigPath
Companion
object
class Object
trait Matchable
class Any
object Profig

Value members

Concrete methods

def clear(): Unit
override
def instance: Profig
Definition Classes
def json: Value
def lastModified: Long
def loadEnvironmentVariables(`type`: MergeType): Unit
def loadProperties(`type`: MergeType): Unit
override
def path: Path
Definition Classes
override
def remove(): Unit
Definition Classes

Inherited methods

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

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

Inherited from
ProfigPath
def as[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 Params
T

the type to represent the current path

Value Params
default

the default to be used if this path is empty

Returns

T

Inherited from
ProfigPath
def as[T : Writer]: T

Loads this path out as the defined type T.

Loads this path out as the defined type T.

Type Params
T

the type to represent the current path

Returns

T

Inherited from
ProfigPath
def exists(): Boolean

True if this path exists in the config

True if this path exists in the config

Inherited from
ProfigPath
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]

Inherited from
ProfigPath
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
def merge(json: Value, `type`: MergeType): Unit

Merges a Json object to this path.

Merges a Json object to this path.

Inherited from
ProfigPath
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 Params
T

the type to represent the current path

Returns

T

Inherited from
ProfigPath
def remove(field: String): Unit

Removes a field from this path.

Removes a field from this path.

Value Params
field

the field below this path to remove

Inherited from
ProfigPath
def store[T : Reader](value: T): Unit

Stores the supplied value into this path.

Stores the supplied value into this path.

Type Params
T

the type of value

Value Params
value

the value to store

Inherited from
ProfigPath