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

Commit

Permalink
Update Javadocs for variation methods to correctly explain the purpos…
Browse files Browse the repository at this point in the history
…e of defaultValue (#265)
  • Loading branch information
aengelberg authored May 12, 2022
1 parent c702d43 commit d8b5ff2
Showing 1 changed file with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public interface LDClientInterface extends Closeable {
* @param featureKey the unique key for the feature flag
* @param user the end user requesting the flag
* @param defaultValue the default value of the flag
* @return whether or not the flag should be enabled, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
* @return the variation for the given user, or {@code defaultValue} if there is an error fetching the variation or the flag doesn't exist
*/
boolean boolVariation(String featureKey, LDUser user, boolean defaultValue);

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

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

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

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

0 comments on commit d8b5ff2

Please sign in to comment.