org.deephacks.tools4j.config.internal.core.runtime.typesafe.package.html Maven / Gradle / Ivy
An API for loading and using configuration files, see the project site
for more information.
Typically you would load configuration with a static method from {@link
org.deephacks.tools4j.config.internal.core.runtime.typesafe.ConfigFactory} and then use
it with methods in the {@link org.deephacks.tools4j.config.internal.core.runtimtypesafeig.Config} interface.
An application can simply call {@link
org.deephacks.tools4j.config.internal.core.runtime.typesafe.ConfigFactory#load()} and place
its configuration in "application.conf" on the classpath.
If you use the default configuration from {@link
org.deephacks.tools4j.config.internal.cortypesafeime.config.ConfigFactory#load()}
there's no need to pass a configuration to your libraries
and frameworks, as long as they all default to this same default, which they should.
A library or framework should ship a file "reference.conf" in its jar, and allow an application to pass in a
{@link org.deephacks.tools4j.config.internal.core.runtime.typesafe.Config} to be used for the library. If no {@link org.deephacks.tools4j.config.internal.core.runtime.typesafe.Config} is provided,
call {@link org.deephacks.tools4j.config.internal.core.runtime.typesafe.ConfigFactory#load()}
to get the default one. Typically a library might offer two constructors, one with a Config parameter
and one which uses {@link org.deephacks.tools4j.config.internal.core.runtime.typesafe.ConfigFactory#load()}.
You can find an example app and library on GitHub.