From cca450264ec87244ff7229afaf1254718030f38d Mon Sep 17 00:00:00 2001 From: Mark Struberg Date: Fri, 11 May 2018 11:36:03 +0200 Subject: [PATCH] refs: #9 improve docs for getResolvedKey Signed-off-by: Mark Struberg --- api/src/main/java/javax/config/ConfigValue.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/api/src/main/java/javax/config/ConfigValue.java b/api/src/main/java/javax/config/ConfigValue.java index f2ef6f8..697f049 100644 --- a/api/src/main/java/javax/config/ConfigValue.java +++ b/api/src/main/java/javax/config/ConfigValue.java @@ -210,13 +210,15 @@ public interface ConfigValue { /** * 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();