Package com.launchdarkly.sdk.android.integrations

Class TestData.FlagBuilder

java.lang.Object

com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder

Enclosing class:

TestData

public static final class TestData.FlagBuilder
extends Object

A builder for feature flag configurations to be used with TestData.

See Also:

• TestData.flag(String)
• TestData.update(FlagBuilder)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TestData.FlagBuilder.VariationFunc<T>	A functional interface for use with variationFunc(VariationFunc) or variationIndexFunc(VariationFunc).

Method Summary

Modifier and Type	Method	Description
TestData.FlagBuilder	booleanFlag()	A shortcut for setting the flag to use the standard boolean configuration.
TestData.FlagBuilder	variation(boolean variation)	Sets the flag to return the specified boolean variation for all contexts by default.
TestData.FlagBuilder	variation(int variationIndex)	Sets the flag to return the specified variation for all contexts by default.
TestData.FlagBuilder	variation(LDValue value)	Sets the flag to return the specified variation for all contexts by default.
TestData.FlagBuilder	variationForKey(ContextKind contextKind, String contextKey, boolean variation)	Sets the flag to return the specified boolean variation for a specific context by kind and key, overriding any other defaults.
TestData.FlagBuilder	variationForKey(ContextKind contextKind, String contextKey, int variationIndex)	Sets the flag to return the specified variation for a specific context by kind and key, overriding any other defaults.
TestData.FlagBuilder	variationForKey(ContextKind contextKind, String contextKey, LDValue value)	Sets the flag to return the specified variation for a specific context by kind and key, overriding any other defaults.
TestData.FlagBuilder	variationForUser(String userKey, boolean variation)	Sets the flag to return the specified boolean variation for a specific user key, overriding any other defaults.
TestData.FlagBuilder	variationForUser(String userKey, int variationIndex)	Sets the flag to return the specified variation for a specific user key, overriding any other defaults.
TestData.FlagBuilder	variationForUser(String userKey, LDValue value)	Sets the flag to return the specified variation for a specific user key, overriding any other defaults.
TestData.FlagBuilder	variationFunc(TestData.FlagBuilder.VariationFunc<Boolean> variationFunc)	Sets the flag to use a function to determine whether to return true or false for any given context.
TestData.FlagBuilder	variationIndexFunc(TestData.FlagBuilder.VariationFunc<Integer> variationFunc)	Sets the flag to use a function to determine the variation index to return for any given context.
TestData.FlagBuilder	variations(LDValue... values)	Changes the allowable variation values for the flag.
TestData.FlagBuilder	variationValueFunc(TestData.FlagBuilder.VariationFunc<LDValue> variationFunc)	Sets the flag to use a function to determine the variation index to return for any given context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

booleanFlag

public TestData.FlagBuilder booleanFlag()

A shortcut for setting the flag to use the standard boolean configuration.

This is the default for all new flags created with TestData.flag(String). The flag will have two variations, true and false (in that order); it will return false whenever targeting is off, and true when targeting is on if no other settings specify otherwise.

Returns:

the builder

variation

public TestData.FlagBuilder variation(boolean variation)

Sets the flag to return the specified boolean variation for all contexts by default.

The flag's variations are set to true and false if they are not already (equivalent to calling booleanFlag()).

Parameters:

variation - the desired true/false variation to be returned by default

Returns:

the builder

variation

public TestData.FlagBuilder variation(int variationIndex)

Sets the flag to return the specified variation for all contexts by default.

The variation is specified by number, out of whatever variation values have already been defined.

Parameters:

variationIndex - the desired variation: 0 for the first, 1 for the second, etc.

Returns:

the builder

variation

public TestData.FlagBuilder variation(LDValue value)

Sets the flag to return the specified variation for all contexts by default.

The value may be of any JSON type, as defined by LDValue. If the value matches one of the values previously specified with variations(LDValue...), then the variation index is set to the index of that value. Otherwise, the value is added to the variation list.

Parameters:

value - the desired value to be returned for all contexts

Returns:

the builder

variationForUser

public TestData.FlagBuilder variationForUser(String userKey,
 boolean variation)

Sets the flag to return the specified boolean variation for a specific user key, overriding any other defaults.

The flag's variations are set to true and false if they are not already (equivalent to calling booleanFlag()).

Parameters:

userKey - a user key

variation - the desired true/false variation to be returned for this user

Returns:

the builder

See Also:

• variationForUser(String, int)
• variationForUser(String, LDValue)
• variationForKey(ContextKind, String, boolean)

variationForUser

public TestData.FlagBuilder variationForUser(String userKey,
 int variationIndex)

Sets the flag to return the specified variation for a specific user key, overriding any other defaults.

Parameters:

userKey - a user key

variationIndex - the desired variation: 0 for the first, 1 for the second, etc.

Returns:

the builder

See Also:

• variationForUser(String, boolean)
• variationForUser(String, LDValue)
• variationForKey(ContextKind, String, int)

variationForUser

public TestData.FlagBuilder variationForUser(String userKey,
 LDValue value)

Sets the flag to return the specified variation for a specific user key, overriding any other defaults.

The value may be of any JSON type, as defined by LDValue. If the value matches one of the values previously specified with variations(LDValue...), then the variation index is set to the index of that value. Otherwise, the value is added to the variation list.

Parameters:

userKey - a user key

value - the desired variation value

Returns:

the builder

See Also:

• variationForUser(String, boolean)
• variationForUser(String, int)
• variationForKey(ContextKind, String, LDValue)

variationForKey

public TestData.FlagBuilder variationForKey(ContextKind contextKind,
 String contextKey,
 boolean variation)

Sets the flag to return the specified boolean variation for a specific context by kind and key, overriding any other defaults.

The flag's variations are set to true and false if they are not already (equivalent to calling booleanFlag()).

Parameters:

contextKind - the context kind (if null, ContextKind.DEFAULT is used)

contextKey - the context key

variation - the desired true/false variation to be returned for this context

Returns:

the builder

See Also:

• variationForKey(ContextKind, String, int)
• variationForKey(ContextKind, String, LDValue)
• variationForUser(String, boolean)

variationForKey

public TestData.FlagBuilder variationForKey(ContextKind contextKind,
 String contextKey,
 int variationIndex)

Sets the flag to return the specified variation for a specific context by kind and key, overriding any other defaults.

Parameters:

contextKind - the context kind (if null, ContextKind.DEFAULT is used)

contextKey - the context key

variationIndex - the desired variation: 0 for the first, 1 for the second, etc.

Returns:

the builder

See Also:

• variationForKey(ContextKind, String, boolean)
• variationForKey(ContextKind, String, LDValue)
• variationForUser(String, int)

variationForKey

public TestData.FlagBuilder variationForKey(ContextKind contextKind,
 String contextKey,
 LDValue value)

Sets the flag to return the specified variation for a specific context by kind and key, overriding any other defaults.

The value may be of any JSON type, as defined by LDValue. If the value matches one of the values previously specified with variations(LDValue...), then the variation index is set to the index of that value. Otherwise, the value is added to the variation list.

Parameters:

contextKind - the context kind (if null, ContextKind.DEFAULT is used)

contextKey - the context key

value - the desired variation value

Returns:

the builder

See Also:

• variationForKey(ContextKind, String, boolean)
• variationForKey(ContextKind, String, int)
• variationForUser(String, LDValue)

variationFunc

public TestData.FlagBuilder variationFunc(TestData.FlagBuilder.VariationFunc<Boolean> variationFunc)

Sets the flag to use a function to determine whether to return true or false for any given context.

This function takes an evaluation context and returns true, false, or null. A null result means that the flag will fall back to its default variation.

The flag's variations are set to true and false if they are not already (equivalent to calling booleanFlag()).

This function is called only if the context was not specifically targeted with variationForUser(String, boolean) or variationForKey(ContextKind, String, boolean).

Parameters:

variationFunc - a function to determine the variation

Returns:

the builder

variationValueFunc

public TestData.FlagBuilder variationValueFunc(TestData.FlagBuilder.VariationFunc<LDValue> variationFunc)

Sets the flag to use a function to determine the variation index to return for any given context.

This function takes an evaluation context and returns an LDValue. The value must match one of the values already specified with variations(LDValue...); otherwise, the function will have no effect.

This function is called only if the context was not specifically targeted with a method such as variationForUser(String, int) or variationForKey(ContextKind, String, int).

Parameters:

variationFunc - a function to determine the variation

Returns:

the builder

variationIndexFunc

public TestData.FlagBuilder variationIndexFunc(TestData.FlagBuilder.VariationFunc<Integer> variationFunc)

Sets the flag to use a function to determine the variation index to return for any given context.

This function takes an evaluation context and returns an integer variation index or null. A null result means that the flag will fall back to its default variation.

This function is called only if the context was not specifically targeted with variationForUser(String, int) or variationForKey(ContextKind, String, int).

Parameters:

variationFunc - a function to determine the variation

Returns:

the builder

variations

public TestData.FlagBuilder variations(LDValue... values)

Changes the allowable variation values for the flag.

The value may be of any JSON type, as defined by LDValue. For instance, a boolean flag normally has LDValue.of(true), LDValue.of(false); a string-valued flag might have LDValue.of("red"), LDValue.of("green"); etc.

Parameters:

values - the desired variations

Returns:

the builder