ConfigObjectSource

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.

   Definition Classes

   ConfigSource

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. def config(): Result[Config]

   

   Reads a Config from this config source.

   Reads a Config from this config source. The returned config is usually unresolved, unless the source forces it otherwise.

   returns

   a Config provided by this source.

8. 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.

   Definition Classes

   ConfigSource

9. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. 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.

    Definition Classes

    ConfigSource

13. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

14. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

15. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

16. 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 type A from this source, a Failure with details on why it isn't possible otherwise

    Definition Classes

    ConfigSource

17. 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 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.

    Definition Classes

    ConfigSource

    Annotations

    @throws( ... )

18. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

19. final def notify(): Unit

    

    Definition Classes

    AnyRef

20. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

21. def optional: ConfigObjectSource

    

    Returns a ConfigObjectSource that provides the same config as this one, but falls back to providing an empty config when the source cannot be read.

    Returns a ConfigObjectSource that provides the same config as this one, but falls back to providing an empty config when the source cannot be read. It can be used together with .withFallback to specify optional config files to be merged (like reference.conf).

    returns

    a new ConfigObjectSource that provides the same config as this one, but falls back to an empty config if it cannot be read.

22. def recoverWith(f: PartialFunction[ConfigReaderFailures, ConfigObjectSource]): ConfigObjectSource

    

    Applies a function f if this source returns a failure, returning an alternative config source in those cases.

    Applies a function f if this source returns a failure, returning an alternative config source in those cases.

    f

    the function to apply if this source returns a failure

    returns

    a new ConfigObjectSource that provides an alternative config in case this source fails

23. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

24. def toString(): String

    

    Definition Classes

    AnyRef → Any

25. def value(): Result[ConfigObject]

    

    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.

    Definition Classes

    ConfigObjectSource → ConfigSource

26. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

27. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

29. def withFallback(cs: ConfigObjectSource): ConfigObjectSource

    

    Merges this source with another one, with the latter being used as a fallback (e.g.

    Merges this source with another one, with the latter being used as a fallback (e.g. the source on which this method is called takes priority). Both sources are required to produce a config object successfully.

    cs

    the config source to use as fallback

    returns

    a new ConfigObjectSource that loads configs from both sources and uses cs as a fallback for this source