trait ConfigSource extends AnyRef

A representation of a source from which ConfigValues 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.

Linear Supertypes
AnyRef, Any
Known Subclasses
ConfigObjectSource
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigSource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def value(): Result[ConfigValue]

    Retrieves a ConfigValue from this source.

    Retrieves a ConfigValue from this source. This forces the config to be resolved, if needed.

    returns

    a ConfigValue retrieved from this source.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. 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.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. 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.

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def load[A](implicit reader: 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 type A from this source, a Failure with details on why it isn't possible otherwise

  15. final def loadOrThrow[A](implicit arg0: ClassTag[A], reader: 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 of A, this method throws a ConfigReaderException.

    A

    the type of the config to be loaded

    returns

    The configuration of type A loaded from this source.

    Annotations
    @throws("")
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped