EmptyConfig

laika.config.EmptyConfig$
object EmptyConfig extends Config

An empty configuration instance.

Attributes

Graph
Supertypes
trait Config
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def get[T](key: Key)(implicit decoder: ConfigDecoder[T]): ConfigResult[T]

Retrieve a required value for the specified key and decoder.

Retrieve a required value for the specified key and decoder.

Attributes

def hasKey(key: Key): Boolean

Verifies whether this config instance contains a value mapped to the specified key.

Verifies whether this config instance contains a value mapped to the specified key.

Attributes

def withFallback(other: Config): Config

Returns a new configuration instance using the specified instance as a fallback for keys not found in this instance.

Returns a new configuration instance using the specified instance as a fallback for keys not found in this instance.

If this instance already has a fallback, the new fallback will be passed further down the chain.

Attributes

def withOrigin(newOrigin: Origin): Config

Returns a new configuration instance using the specified origin.

Returns a new configuration instance using the specified origin.

Attributes

Inherited methods

def get[T](implicit decoder: ConfigDecoder[T], defaultKey: DefaultKey[T]): ConfigResult[T]

Retrieve a required value for the specified implicit key and decoder.

Retrieve a required value for the specified implicit key and decoder.

A defaultKey can be used for commonly used configuration objects like AutonumberConfig that are expected to be mapped to a specific key, like autonumbering.

Attributes

Inherited from:
Config
def get[T](key: String, default: => T)(implicit decoder: ConfigDecoder[T]): ConfigResult[T]

Retrieve an optional value for the specified key and decoder, falling back to the given default if the value is missing.

Retrieve an optional value for the specified key and decoder, falling back to the given default if the value is missing.

Attributes

Inherited from:
Config
def get[T](key: Key, default: => T)(implicit decoder: ConfigDecoder[T]): ConfigResult[T]

Retrieve an optional value for the specified key and decoder, falling back to the given default if the value is missing.

Retrieve an optional value for the specified key and decoder, falling back to the given default if the value is missing.

Attributes

Inherited from:
Config
def get[T](key: String)(implicit decoder: ConfigDecoder[T]): ConfigResult[T]

Retrieve a required value for the specified key and decoder.

Retrieve a required value for the specified key and decoder.

Attributes

Inherited from:
Config
def getOpt[T](key: String)(implicit decoder: ConfigDecoder[T]): ConfigResult[Option[T]]

Retrieve an optional value for the specified key and decoder. The result is still an Either as this method might still fail even if the value is present in case the decoding fails.

Retrieve an optional value for the specified key and decoder. The result is still an Either as this method might still fail even if the value is present in case the decoding fails.

Attributes

Inherited from:
Config
def getOpt[T](implicit decoder: ConfigDecoder[T], defaultKey: DefaultKey[T]): ConfigResult[Option[T]]

Retrieve an optional value for the specified implicit key and decoder.

Retrieve an optional value for the specified implicit key and decoder.

A defaultKey can be used for commonly used configuration objects like AutonumberConfig that are expected to be mapped to a specific key, like autonumbering.

The result is still an Either as this method might still fail even if the value is present in case the decoding fails.

Attributes

Inherited from:
Config
def getOpt[T](key: Key)(implicit decoder: ConfigDecoder[T]): ConfigResult[Option[T]]

Retrieve an optional value for the specified key and decoder. The result is still an Either as this method might still fail even if the value is present in case the decoding fails.

Retrieve an optional value for the specified key and decoder. The result is still an Either as this method might still fail even if the value is present in case the decoding fails.

Attributes

Inherited from:
Config
def hasKey(key: String): Boolean

Verifies whether this config instance contains a value mapped to the specified key.

Verifies whether this config instance contains a value mapped to the specified key.

Attributes

Inherited from:
Config
def withValue[T](value: T)(implicit encoder: ConfigEncoder[T], defaultKey: DefaultKey[T]): ConfigBuilder

Creates a new configuration builder with the specified value and this instance as a fallback. The returned builder can be used to add further values before calling build to retrieve a new instance.

Creates a new configuration builder with the specified value and this instance as a fallback. The returned builder can be used to add further values before calling build to retrieve a new instance.

Attributes

Inherited from:
Config
def withValue[T](key: Key, value: T)(implicit encoder: ConfigEncoder[T]): ConfigBuilder

Creates a new configuration builder with the specified value and this instance as a fallback. The returned builder can be used to add further values before calling build to retrieve a new instance.

Creates a new configuration builder with the specified value and this instance as a fallback. The returned builder can be used to add further values before calling build to retrieve a new instance.

Attributes

Inherited from:
Config
def withValue[T](key: String, value: T)(implicit encoder: ConfigEncoder[T]): ConfigBuilder

Creates a new configuration builder with the specified value and this instance as a fallback. The returned builder can be used to add further values before calling build to retrieve a new instance.

Creates a new configuration builder with the specified value and this instance as a fallback. The returned builder can be used to add further values before calling build to retrieve a new instance.

Attributes

Inherited from:
Config

Concrete fields

val origin: Origin

The origin of this configuration, which might come from programmatic configuration, a file in one of the input directories, a configuration header in a markup document or from an attribute section in a directive.

The origin of this configuration, which might come from programmatic configuration, a file in one of the input directories, a configuration header in a markup document or from an attribute section in a directive.

Attributes