profig
API
Generated with
profig/profig/Profig

Profig

profig.Profig
See theProfig companion object
class Profig extends ProfigPath

Attributes

Companion
object
Graph
Supertypes
trait ProfigPath
class Object
trait Matchable
class Any
Known subtypes
object Profig.type

Members list

Value members

Concrete methods

def clear(): Unit
override def instance: Profig

Attributes

Definition Classes
def json: Json
def lastModified: Long
def loadEnvironmentMap(map: Map[String, String], `type`: MergeType): Unit
def loadEnvironmentVariables(`type`: MergeType): Unit
def loadProperties(`type`: MergeType): Unit
override def path: JsonPath

Attributes

Definition Classes
override def remove(): Unit

Removes this path

Removes this path

Attributes

Definition Classes

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 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
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 loadFile(file: File, mergeType: MergeType, errorHandler: Option[Throwable => Unit]): Unit

Attributes

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