Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit d8b5ff2

Browse files
authored
Update Javadocs for variation methods to correctly explain the purpose of defaultValue (#265)
1 parent c702d43 commit d8b5ff2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/main/java/com/launchdarkly/sdk/server/interfaces/LDClientInterface.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public interface LDClientInterface extends Closeable {
8686
* @param featureKey the unique key for the feature flag
8787
* @param user the end user requesting the flag
8888
* @param defaultValue the default value of the flag
89-
* @return whether or not the flag should be enabled, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
89+
* @return the variation for the given user, or {@code defaultValue} if there is an error fetching the variation or the flag doesn't exist
9090
*/
9191
boolean boolVariation(String featureKey, LDUser user, boolean defaultValue);
9292

@@ -98,7 +98,7 @@ public interface LDClientInterface extends Closeable {
9898
* @param featureKey the unique key for the feature flag
9999
* @param user the end user requesting the flag
100100
* @param defaultValue the default value of the flag
101-
* @return the variation for the given user, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
101+
* @return the variation for the given user, or {@code defaultValue} if there is an error fetching the variation or the flag doesn't exist
102102
*/
103103
int intVariation(String featureKey, LDUser user, int defaultValue);
104104

@@ -108,7 +108,7 @@ public interface LDClientInterface extends Closeable {
108108
* @param featureKey the unique key for the feature flag
109109
* @param user the end user requesting the flag
110110
* @param defaultValue the default value of the flag
111-
* @return the variation for the given user, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
111+
* @return the variation for the given user, or {@code defaultValue} if there is an error fetching the variation or the flag doesn't exist
112112
*/
113113
double doubleVariation(String featureKey, LDUser user, double defaultValue);
114114

@@ -118,7 +118,7 @@ public interface LDClientInterface extends Closeable {
118118
* @param featureKey the unique key for the feature flag
119119
* @param user the end user requesting the flag
120120
* @param defaultValue the default value of the flag
121-
* @return the variation for the given user, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
121+
* @return the variation for the given user, or {@code defaultValue} if there is an error fetching the variation or the flag doesn't exist
122122
*/
123123
String stringVariation(String featureKey, LDUser user, String defaultValue);
124124

@@ -128,7 +128,7 @@ public interface LDClientInterface extends Closeable {
128128
* @param featureKey the unique key for the feature flag
129129
* @param user the end user requesting the flag
130130
* @param defaultValue the default value of the flag
131-
* @return the variation for the given user, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel;
131+
* @return the variation for the given user, or {@code defaultValue} if there is an error fetching the variation or the flag doesn't exist;
132132
* will never be a null reference, but may be {@link LDValue#ofNull()}
133133
*
134134
* @since 4.8.0

0 commit comments

Comments
 (0)