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

fix api doc note about setUseSystemProperties doing nothing

Browse Source 
This is a mess, I earlier added a note to the README about needing
to fix it.
This commit is contained in:
Havoc Pennington 2011-11-29 08:56:25 -05:00
parent a840c2599d
commit 9af5a67d6c
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -57,16 +57,17 @@ public final class ConfigFactory {
/**
* Like {@link #load(String)} but allows you to specify parse and resolve
* options.
*
* <p>
* To be aware of: using
* {@link ConfigResolveOptions#setUseSystemProperties(boolean)
* setUseSystemProperties(false)} with this method has no meaningful effect,
* setUseSystemProperties(false)} with this method has little effect,
* because the system properties are merged into the config as overrides
* anyway. <code>setUseSystemProperties</code> affects whether to fall back
* to system properties when they are not found in the config, but with
* <code>load()</code>, they will be in the config.
*
* <code>load()</code>, they will be in the config. There is one situation
* where <code>setUseSystemProperties(false)</code> comes into play, which
* is that files included into another file may find the system property
* fallbacks but not the overrides.
* @param resourceBasename
* the classpath resource name with optional extension
* @param parseOptions
@ -99,16 +100,18 @@ public final class ConfigFactory {
/**
* Like {@link #load(Config)} but allows you to specify
* {@link ConfigResolveOptions}.
*
* <p>
* To be aware of: using
* {@link ConfigResolveOptions#setUseSystemProperties(boolean)
* setUseSystemProperties(false)} with this method has no meaningful effect,
* setUseSystemProperties(false)} with this method has little effect,
* because the system properties are merged into the config as overrides
* anyway. <code>setUseSystemProperties</code> affects whether to fall back
* to system properties when they are not found in the config, but with
* <code>load()</code>, they will be in the config.
*
* <code>load()</code>, they will be in the config. There is one situation
* where <code>setUseSystemProperties(false)</code> comes into play, which
* is that files included into another file may find the system property
* fallbacks but not the overrides.
*
* @param config
* the application's portion of the configuration
* @param resolveOptions