profig/profig/Profig

Profig

object Profig extends Profig

Profig provides access to environment variables, properties, and other configuration all merged together into one powerful system. Uses JSON internally to provide merging and integration. Paths are dot-separated.

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

Value members

Concrete methods

def init(loadProperties: Boolean, loadEnvironmentVariables: Boolean): Unit

Initializes Profig

Initializes Profig

Value parameters:
loadEnvironmentVariables

whether to load environment variables

loadProperties

whether to load system properties

def isLoaded: Boolean

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]: 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

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

Inherited from:
ProfigPath
def clear(): Unit
Inherited from:
Profig
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
override def instance: Profig
Definition Classes
Inherited from:
Profig
def json: Value
Inherited from:
Profig
def lastModified: Long
Inherited from:
Profig
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 loadEnvironmentVariables(`type`: MergeType): Unit
Inherited from:
Profig
def loadFile(file: File, mergeType: MergeType, errorHandler: Option[Throwable => Unit]): Unit
Inherited from:
ProfigPathPlatform
def loadProperties(`type`: MergeType): Unit
Inherited from:
Profig
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 parameters:
T

the type to represent the current path

Returns:

T

Inherited from:
ProfigPath
override def path: Path
Definition Classes
Inherited from:
Profig
override def remove(): Unit
Definition Classes
Inherited from:
Profig
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

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 parameters:
T

the type of value

Value parameters:
value

the value to store

Inherited from:
ProfigPath