trait ConfigSource extends AnyRef
A representation of a source from which ConfigValue
s can be loaded, such as a file or a URL.
A source allows users to load configs from this source as any type for which a ConfigReader
is
available. Raw configs can also be retrieved as a ConfigValue
, a ConfigCursor
or a
FluentConfigCursor
. Before using any of the loading methods described, Users can opt to focus
on a specific part of a config by specifying a namespace.
All config loading methods are lazy and defer resolution of references until needed.
- Alphabetic
- By Inheritance
- ConfigSource
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def at(namespace: String): ConfigSource
Navigates through the config to focus on a namespace.
Navigates through the config to focus on a namespace.
- namespace
the namespace to focus on
- returns
a new
ConfigSource
focused on the given namespace.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def cursor(): Result[ConfigCursor]
Returns a cursor for a
ConfigValue
retrieved from this source.Returns a cursor for a
ConfigValue
retrieved from this source.- returns
a cursor for a
ConfigValue
retrieved from this source.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def fluentCursor(): FluentConfigCursor
Returns a fluent cursor for a
ConfigValue
retrieved from this source.Returns a fluent cursor for a
ConfigValue
retrieved from this source.- returns
a fluent cursor for a
ConfigValue
retrieved from this source.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def load[A](implicit reader: Derivation[ConfigReader[A]]): Result[A]
Loads a configuration of type
A
from this source.Loads a configuration of type
A
from this source.- A
the type of the config to be loaded
- returns
A
Right
with the configuration if it is possible to create an instance of typeA
from this source, aFailure
with details on why it isn't possible otherwise
- final def loadOrThrow[A](implicit arg0: ClassTag[A], reader: Derivation[ConfigReader[A]]): A
Loads a configuration of type
A
from this source.Loads a configuration of type
A
from this source. If it is not possible to create an instance ofA
, this method throws aConfigReaderException
.- A
the type of the config to be loaded
- returns
The configuration of type
A
loaded from this source.
- Annotations
- @throws(scala.this.throws.<init>$default$1[pureconfig.error.ConfigReaderException[_]])
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()