profig
API
Generated with
profig/profig/Profig

Profig

profig.Profig$
See theProfig companion class
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.

Attributes

Companion
class
Graph
Supertypes
class Profig
trait ProfigPath
class Object
trait Matchable
class Any
Show all
Self type
Profig.type

Members list

Value members

Concrete methods

def empty: Profig
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

Attributes

def isLoaded: Boolean
def reset(): Unit

Inherited methods

def apply(): Json

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

Inherited from:
ProfigPath
def apply(path: JsonPath): ProfigPath

Attributes

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.

Attributes

Returns

ProfigPath

Inherited from:
ProfigPath
def as[T : RW]: 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

Attributes

Returns

T

Inherited from:
ProfigPath
def asOr[T : RW](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

Attributes

Returns

T

Inherited from:
ProfigPath
def clear(): Unit

Attributes

Inherited from:
Profig
def exists(): Boolean

True if this path exists in the config

True if this path exists in the config

Attributes

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

Attributes

Returns

Option[Json]

Inherited from:
ProfigPath
def initConfiguration(startPath: Path, additionalPaths: List[Path], recursiveParents: Boolean, includeClassPath: Boolean, fileNameMatcher: FileNameMatcher, errorHandler: Option[Throwable => Unit]): Unit

Attributes

Inherited from:
ProfigPathPlatform
override def instance: Profig

Attributes

Definition Classes
Inherited from:
Profig
def json: Json

Attributes

Inherited from:
Profig
def lastModified: Long

Attributes

Inherited from:
Profig
def load(fileName: String, source: Source, mergeType: MergeType, errorHandler: Option[Throwable => Unit]): Unit

Attributes

Inherited from:
ProfigPathPlatform
def loadConfiguration(startPath: Path, additionalPaths: List[Path], recursiveParents: Boolean, includeClassPath: Boolean, fileNameMatcher: FileNameMatcher, errorHandler: Option[Throwable => Unit]): Unit

Attributes

Inherited from:
ProfigPathPlatform
def loadEnvironmentVariables(`type`: MergeType): Unit

Attributes

Inherited from:
Profig
def loadFile(file: File, mergeType: MergeType, errorHandler: Option[Throwable => Unit]): Unit

Attributes

Inherited from:
ProfigPathPlatform
def loadProperties(`type`: MergeType): Unit

Attributes

Inherited from:
Profig
def map(keys: (String, String)*): Unit

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

Inherited from:
ProfigPath
def merge(json: Json, `type`: MergeType): Unit

Merges a Json object to this path.

Merges a Json object to this path.

Attributes

Inherited from:
ProfigPath
def opt[T : RW]: 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

Attributes

Returns

T

Inherited from:
ProfigPath
override def path: JsonPath

Attributes

Definition Classes
Inherited from:
Profig
override def remove(): Unit

Removes this path

Removes this path

Attributes

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

Attributes

Inherited from:
ProfigPath
def store[T : RW](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

Attributes

Inherited from:
ProfigPath
Generated with