Skip to content

Commit bad495b

Browse files
committed
mention in Config.resolve docs that ConfigFactory methods may call it for you
1 parent 29c7d62 commit bad495b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

config/src/main/java/com/typesafe/config/Config.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,16 @@ public interface Config extends ConfigMergeable {
142142
* }
143143
* </pre>
144144
*
145+
* <p>
146+
* Many methods on {@link ConfigFactory} such as {@link
147+
* ConfigFactory#load()} automatically resolve the loaded
148+
* <code>Config</code> on the loaded stack of config files.
149+
*
150+
* <p> Resolving an already-resolved config is a harmless
151+
* no-op, but again, it is best to resolve an entire stack of
152+
* fallbacks (such as all your config files combined) rather
153+
* than resolving each one individually.
154+
*
145155
* @return an immutable object with substitutions resolved
146156
* @throws ConfigException.UnresolvedSubstitution
147157
* if any substitutions refer to nonexistent paths

0 commit comments

Comments
 (0)