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

Mention the need to call resolve() in the Config docs

Browse Source
This commit is contained in:
Havoc Pennington 2013-05-19 10:29:05 -04:00
parent 4a62e10754
commit 29c7d62a52
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config/src/main/java/com/typesafe/config/Config.java
View File

@ -66,6 +66,10 @@ import java.util.Set;
* can use {@link #entrySet()} which recurses the object tree for you and builds
* up a <code>Set</code> of all path-value pairs where the value is not null.
*
* <p>Before using a {@code Config} it's necessary to call {@link Config#resolve()}
* to handle substitutions (though {@link ConfigFactory#load()} and similar methods
* will do the resolve for you already).
*
* <p> You can find an example app and library <a
* href="https://github.com/typesafehub/config/tree/master/examples">on
* GitHub</a>. Also be sure to read the package overview