com.launchdarkly.sdk.server

Class FeatureFlagsState.Builder

java.lang.Object

com.launchdarkly.sdk.server.FeatureFlagsState.Builder

Enclosing class:

FeatureFlagsState

public static class FeatureFlagsState.Builder
extends java.lang.Object

A builder for a FeatureFlagsState instance.

Application code will not normally use this builder, since the SDK creates its own instances. However, it may be useful in testing, to simulate values that might be returned by LDClient.allFlagsState(com.launchdarkly.sdk.LDContext, FlagsStateOption...).

Since:

5.6.0

Method Summary

Modifier and Type	Method and Description
FeatureFlagsState.Builder	add(java.lang.String flagKey, LDValue value, java.lang.Integer variationIndex, EvaluationReason reason, int flagVersion, boolean trackEvents, boolean trackReason, java.lang.Long debugEventsUntilDate, java.util.List<java.lang.String> prerequisites) Adds data to the builder representing the result of a feature flag evaluation.
FeatureFlagsState.Builder	add(java.lang.String flagKey, LDValue value, java.lang.Integer variationIndex, EvaluationReason reason, int flagVersion, boolean trackEvents, java.lang.Long debugEventsUntilDate, java.util.List<java.lang.String> prerequisites) Adds data to the builder representing the result of a feature flag evaluation.
FeatureFlagsState	build() Returns an object created from the builder state.
FeatureFlagsState.Builder	valid(boolean valid) Sets the FeatureFlagsState.isValid() property.

Methods inherited from class java.lang.Object

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

Method Detail

valid

public FeatureFlagsState.Builder valid(boolean valid)

Sets the FeatureFlagsState.isValid() property. This is true by default.

Parameters:

valid - the new property value

Returns:

the builder

add

public FeatureFlagsState.Builder add(java.lang.String flagKey,
                                     LDValue value,
                                     java.lang.Integer variationIndex,
                                     EvaluationReason reason,
                                     int flagVersion,
                                     boolean trackEvents,
                                     java.lang.Long debugEventsUntilDate,
                                     java.util.List<java.lang.String> prerequisites)

Adds data to the builder representing the result of a feature flag evaluation.

The flagVersion, trackEvents, and debugEventsUntilDate parameters are normally generated internally by the SDK; they are used if the FeatureFlagsState data has been passed to front-end code, to control how analytics events are generated by the front end. If you are using this builder in back-end test code, those values are unimportant.

Parameters:

flagKey - the feature flag key

value - the evaluated value

variationIndex - the evaluated variation index

reason - the evaluation reason

flagVersion - the current flag version

trackEvents - true if full event tracking is turned on for this flag

debugEventsUntilDate - if set, event debugging is turned until this time (millisecond timestamp)

prerequisites - list of flag keys of the top level prerequisite flags evaluated as part of this evaluation

Returns:

the builder

add

public FeatureFlagsState.Builder add(java.lang.String flagKey,
                                     LDValue value,
                                     java.lang.Integer variationIndex,
                                     EvaluationReason reason,
                                     int flagVersion,
                                     boolean trackEvents,
                                     boolean trackReason,
                                     java.lang.Long debugEventsUntilDate,
                                     java.util.List<java.lang.String> prerequisites)

Adds data to the builder representing the result of a feature flag evaluation.

The flagVersion, trackEvents, and debugEventsUntilDate parameters are normally generated internally by the SDK; they are used if the FeatureFlagsState data has been passed to front-end code, to control how analytics events are generated by the front end. If you are using this builder in back-end test code, those values are unimportant.

Parameters:

flagKey - the feature flag key

value - the evaluated value

variationIndex - the evaluated variation index

reason - the evaluation reason

flagVersion - the current flag version

trackEvents - true if full event tracking is turned on for this flag

trackReason - true if evaluation reasons must be included due to experimentation

debugEventsUntilDate - if set, event debugging is turned until this time (millisecond timestamp)

prerequisites - list of flag keys of the top level prerequisite flags evaluated as part of this evaluation

Returns:

the builder

build

public FeatureFlagsState build()

Returns an object created from the builder state.

Returns:

an immutable FeatureFlagsState