github-repos/config
1
0
Fork 0
mirror of https://github.com/lightbend/config.git synced 2025-02-23 17:50:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

add docs to load() pointing to parseResourcesAnySyntax()

Browse Source
This commit is contained in:
Havoc Pennington 2013-07-01 15:19:55 -04:00
parent 2c106ad940
commit b57b569420
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
config/src/main/java/com/typesafe/config/ConfigFactory.java
View File

@ -60,6 +60,12 @@ public final class ConfigFactory {
* you want to parse additional files or something then you need to use * you want to parse additional files or something then you need to use
* {@link #load(Config)}. * {@link #load(Config)}.
* *
* <p>
* To load a standalone resource (without the default reference and default
* overrides), use {@link #parseResourcesAnySyntax(String)} rather than this
* method. To load only the reference config use {@link #defaultReference()}
* and to load only the overrides use {@link #defaultOverrides()}.
*
* @param resourceBasename * @param resourceBasename
* name (optionally without extension) of a resource on classpath * name (optionally without extension) of a resource on classpath
* @return configuration for an application relative to context class loader * @return configuration for an application relative to context class loader
@ -73,6 +79,13 @@ public final class ConfigFactory {
* Like {@link #load(String)} but uses the supplied class loader instead of * Like {@link #load(String)} but uses the supplied class loader instead of
* the current thread's context class loader. * the current thread's context class loader.
* *
* <p>
* To load a standalone resource (without the default reference and default
* overrides), use {@link #parseResourcesAnySyntax(ClassLoader, String)}
* rather than this method. To load only the reference config use
* {@link #defaultReference(ClassLoader)} and to load only the overrides use
* {@link #defaultOverrides(ClassLoader)}.
*
* @param loader * @param loader
* @param resourceBasename * @param resourceBasename
* @return configuration for an application relative to given class loader * @return configuration for an application relative to given class loader