com.launchdarkly.client

Class FeatureFlagsState

java.lang.Object

com.launchdarkly.client.FeatureFlagsState

public class FeatureFlagsState
extends java.lang.Object

A snapshot of the state of all feature flags with regard to a specific user, generated by calling LDClientInterface.allFlagsState(LDUser, FlagsStateOption...).

Serializing this object to JSON using Gson will produce the appropriate data structure for bootstrapping the LaunchDarkly JavaScript client.

Since:

4.3.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
EvaluationReason	getFlagReason(java.lang.String key) Returns the evaluation reason for an individual feature flag at the time the state was recorded.
com.google.gson.JsonElement	getFlagValue(java.lang.String key) Returns the value of an individual feature flag at the time the state was recorded.
int	hashCode()
boolean	isValid() Returns true if this object contains a valid snapshot of feature flag state, or false if the state could not be computed (for instance, because the client was offline or there was no user).
java.util.Map<java.lang.String,com.google.gson.JsonElement>	toValuesMap() Returns a map of flag keys to flag values.

Methods inherited from class java.lang.Object

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

Method Detail

isValid

public boolean isValid()

Returns true if this object contains a valid snapshot of feature flag state, or false if the state could not be computed (for instance, because the client was offline or there was no user).

Returns:

true if the state is valid

getFlagValue

public com.google.gson.JsonElement getFlagValue(java.lang.String key)

Returns the value of an individual feature flag at the time the state was recorded.

Parameters:

key - the feature flag key

Returns:

the flag's JSON value; null if the flag returned the default value, or if there was no such flag

getFlagReason

public EvaluationReason getFlagReason(java.lang.String key)

Returns the evaluation reason for an individual feature flag at the time the state was recorded.

Parameters:

key - the feature flag key

Returns:

an EvaluationReason; null if reasons were not recorded, or if there was no such flag

toValuesMap

public java.util.Map<java.lang.String,com.google.gson.JsonElement> toValuesMap()

Returns a map of flag keys to flag values. If a flag would have evaluated to the default value, its value will be null.

Do not use this method if you are passing data to the front end to "bootstrap" the JavaScript client. Instead, serialize the FeatureFlagsState object to JSON using Gson.toJson() or Gson.toJsonTree().

Returns:

an immutable map of flag keys to JSON values

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object