Skip to content

Commit

Permalink
refs: eclipse#9 improve docs for getResolvedKey
Browse files Browse the repository at this point in the history
Signed-off-by: Mark Struberg <[email protected]>
  • Loading branch information
struberg committed May 11, 2018
1 parent 93ba47e commit cca4502
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions api/src/main/java/javax/config/ConfigValue.java
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,15 @@ public interface ConfigValue<T> {

/**
* Returns the actual key which led to successful resolution and corresponds to the resolved value.
* This is mostly useful when {@link #withLookupChain(String...)} or {@link #evaluateVariables(boolean)} is used.
* This is useful when {@link #withLookupChain(String...)} is used.
* Otherwise the resolved key should always be equal to the original key.
* This method is provided for cases, when arameterized resolution is
* requested but the value for such appended key is not found and some of the fallback keys is used.
* This method is provided for cases, when parameterized resolution is
* requested and some of the fallback keys is used.
*
* This should be called only after calling {@link #getValue()} otherwise the value is undefined (but likely
* null).
*
* Note that this will only give you the resolved key from the last non-cached value resolving.
*/
String getResolvedKey();

Expand Down

0 comments on commit cca4502

Please sign in to comment.