A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- add(boolean) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(double) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(float) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(int) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(long) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(LDContext) - Method in class com.launchdarkly.sdk.ContextMultiBuilder
-
Adds an individual LDContext for a specific kind to the builer.
- add(LDValue) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(String) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- anonymous(boolean) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets whether the context is only intended for flag evaluations and should not be indexed by LaunchDarkly.
- anonymous(boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets whether this user is anonymous.
- ANONYMOUS - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the anonymous attribute.
- ARRAY - com.launchdarkly.sdk.LDValueType
-
The value is an array.
- ArrayBuilder - Class in com.launchdarkly.sdk
-
A builder created by
LDValue.buildArray()
. - ArrayBuilder() - Constructor for class com.launchdarkly.sdk.ArrayBuilder
- arrayFrom(Iterable<T>) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Initializes an
LDValue
as an array, from a sequence of this type. - arrayOf(LDValue...) - Static method in class com.launchdarkly.sdk.LDValue
-
Creates an array value from the specified values.
- arrayOf(T...) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Initializes an
LDValue
as an array, from a sequence of this type. - AttributeRef - Class in com.launchdarkly.sdk
-
An attribute name or path expression identifying a value within an
LDContext
. - avatar(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's avatar.
- AVATAR - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the avatar URL attribute.
B
- Boolean - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for booleans. - BOOLEAN - com.launchdarkly.sdk.LDValueType
-
The value is a boolean.
- booleanValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a boolean if it is explicitly a boolean.
- build() - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Returns an array containing the builder's current elements.
- build() - Method in class com.launchdarkly.sdk.ContextBuilder
-
Creates an
LDContext
from the current builder properties. - build() - Method in class com.launchdarkly.sdk.ContextMultiBuilder
-
Creates an
LDContext
from the current builder properties. - build() - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Builds the configured
LDUser
object. - build() - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Returns an object containing the builder's current elements.
- buildArray() - Static method in class com.launchdarkly.sdk.LDValue
-
Starts building an array value.
- builder(ContextKind, String) - Static method in class com.launchdarkly.sdk.LDContext
- builder(String) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a
ContextBuilder
for building an LDContext, initializing itskey
and settingkind
toContextKind.DEFAULT
. - Builder(LDUser) - Constructor for class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Creates a builder based on an existing user.
- Builder(String) - Constructor for class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Creates a builder with the specified key.
- builderFromContext(LDContext) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a builder whose properties are the same as an existing single-kind LDContext.
- buildObject() - Static method in class com.launchdarkly.sdk.LDValue
-
Starts building an object value.
C
- CLIENT_NOT_READY - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the caller tried to evaluate a flag before the client had successfully initialized.
- com.launchdarkly.sdk - package com.launchdarkly.sdk
-
Base namespace for LaunchDarkly Java-based SDKs, containing common types.
- com.launchdarkly.sdk.json - package com.launchdarkly.sdk.json
-
Helper classes and methods for interoperability with JSON.
- compareTo(AttributeRef) - Method in class com.launchdarkly.sdk.AttributeRef
- compareTo(ContextKind) - Method in class com.launchdarkly.sdk.ContextKind
- ContextBuilder - Class in com.launchdarkly.sdk
-
A mutable object that uses the builder pattern to specify properties for
LDContext
. - ContextKind - Class in com.launchdarkly.sdk
-
A string identifier provided by the application to describe what kind of entity an
LDContext
represents. - ContextMultiBuilder - Class in com.launchdarkly.sdk
-
A mutable object that uses the builder pattern to specify properties for a multi-kind
LDContext
. - Converter() - Constructor for class com.launchdarkly.sdk.LDValue.Converter
- country(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Set the country for a user.
- COUNTRY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the country attribute.
- create(ContextKind, String) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a single-kind LDContext with only the kind and keys specified.
- create(String) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a single-kind LDContext with a kind of
ContextKind.DEFAULT
} and the specified key. - createMulti(LDContext...) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a multi-kind LDContext out of the specified single-kind LDContexts.
- custom(String, boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a boolean-valued custom attribute.
- custom(String, double) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Adds a double-precision numeric custom attribute.
- custom(String, int) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Adds an integer-valued custom attribute.
- custom(String, LDValue) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a custom attribute whose value can be any JSON type, using
LDValue
. - custom(String, String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Adds a
String
-valued custom attribute.
D
- DEFAULT - Static variable in class com.launchdarkly.sdk.ContextKind
-
A constant for the default kind of "user".
- deserialize(String, Class<T>) - Static method in class com.launchdarkly.sdk.json.JsonSerialization
-
Parses an object from its JSON representation.
- Double - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for doubles. - doubleValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
double
if it is numeric.
E
- email(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's e-mail address.
- EMAIL - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the user key attribute.
- equals(Object) - Method in class com.launchdarkly.sdk.AttributeRef
- equals(Object) - Method in class com.launchdarkly.sdk.ContextKind
- equals(Object) - Method in class com.launchdarkly.sdk.EvaluationDetail
- equals(Object) - Method in class com.launchdarkly.sdk.EvaluationReason
- equals(Object) - Method in class com.launchdarkly.sdk.LDContext
- equals(Object) - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.
- equals(Object) - Method in class com.launchdarkly.sdk.LDValue
-
Returns true if the other object is an
LDValue
that is logically equal. - equals(Object) - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.
- error(EvaluationReason.ErrorKind) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.ERROR
. - error(EvaluationReason.ErrorKind, LDValue) - Static method in class com.launchdarkly.sdk.EvaluationDetail
-
Shortcut for creating an instance with an error result.
- ERROR - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag could not be evaluated, e.g.
- EvaluationDetail<T> - Class in com.launchdarkly.sdk
-
An object returned by the SDK's "variation detail" methods such as
boolVariationDetail
, combining the result of a flag evaluation with an explanation of how it was calculated. - EvaluationReason - Class in com.launchdarkly.sdk
-
Describes the reason that a flag evaluation produced a particular value.
- EvaluationReason.BigSegmentsStatus - Enum in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getBigSegmentsStatus()
. - EvaluationReason.ErrorKind - Enum in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getErrorKind()
. - EvaluationReason.Kind - Enum in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getKind()
. - exception(Exception) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.ERROR
, with an exception instance. - EXCEPTION - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that an unexpected exception stopped flag evaluation.
F
- fallthrough() - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.FALLTHROUGH
. - fallthrough(boolean) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.FALLTHROUGH
and where the inExperiment parameter represents whether the evaluation was part of an experiment. - FALLTHROUGH - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag was on but the user did not match any targets or rules.
- FIRST_NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the first name attribute.
- firstName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's first name
- FLAG_NOT_FOUND - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the caller provided a flag key that did not match any known flag.
- Float - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for floats. - floatValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
float
if it is numeric. - forName(String) - Static method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Returns a UserAttribute instance for the specified attribute name.
- fromLiteral(String) - Static method in class com.launchdarkly.sdk.AttributeRef
-
Similar to
AttributeRef.fromPath(String)
, except that it always interprets the string as a literal attribute name, never as a slash-delimited path expression. - fromPath(String) - Static method in class com.launchdarkly.sdk.AttributeRef
-
Creates an AttributeRef from a string.
- fromType(T) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Converts a value of the specified type to an
LDValue
. - fromUser(LDUser) - Static method in class com.launchdarkly.sdk.LDContext
-
Deprecated.use
LDContext
directly instead. - fromValue(T, int, EvaluationReason) - Static method in class com.launchdarkly.sdk.EvaluationDetail
-
Factory method for an arbitrary value.
G
- get(int) - Method in class com.launchdarkly.sdk.LDValue
-
Returns an array element by index.
- get(String) - Method in class com.launchdarkly.sdk.LDValue
-
Returns an object property by name.
- getAttribute(UserAttribute) - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Gets the value of a user attribute, if present.
- getAvatar() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the avatar property for the user, if set.
- getBigSegmentsStatus() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Describes the validity of Big Segment information, if and only if the flag evaluation required querying at least one Big Segment.
- getComponent(int) - Method in class com.launchdarkly.sdk.AttributeRef
-
Retrieves a single path component from the attribute reference.
- getCountry() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the country property for the user, if set.
- getCustomAttributeNames() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the names of all non-built-in attributes that have been set in this context.
- getCustomAttributes() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns an enumeration of all custom attribute names that were set for this user.
- getDepth() - Method in class com.launchdarkly.sdk.AttributeRef
-
The number of path components in the AttributeRef.
- getEmail() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the email property for the user, if set.
- getError() - Method in class com.launchdarkly.sdk.AttributeRef
-
Null for a valid AttributeRef, or a non-null error message for an invalid AttributeRef.
- getError() - Method in class com.launchdarkly.sdk.LDContext
-
Returns null for a valid LDContext, or an error message for an invalid one.
- getErrorKind() - Method in class com.launchdarkly.sdk.EvaluationReason
-
An enumeration value indicating the general category of error, if the
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - getException() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The exception that caused the error condition, if the
kind
isEvaluationReason.Kind.ERROR
and theerrorKind
isEvaluationReason.ErrorKind.EXCEPTION
. - getFirstName() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the first name property for the user, if set.
- getFullyQualifiedKey() - Method in class com.launchdarkly.sdk.LDContext
-
Returns a string that describes the LDContext uniquely based on
kind
andkey
values. - getIndividualContext(int) - Method in class com.launchdarkly.sdk.LDContext
-
Returns the single-kind LDContext corresponding to one of the kinds in this context.
- getIndividualContext(ContextKind) - Method in class com.launchdarkly.sdk.LDContext
-
Returns the single-kind LDContext corresponding to one of the kinds in this context.
- getIndividualContext(String) - Method in class com.launchdarkly.sdk.LDContext
-
Same as
LDContext.getIndividualContext(ContextKind)
, but specifies the kind as a plain string. - getIndividualContextCount() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the number of context kinds in this context.
- getIp() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the IP property for the user, if set.
- getKey() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the context's
key
attribute. - getKey() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the user's unique key.
- getKind() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an enum indicating the general category of the reason.
- getKind() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the context's
kind
attribute. - getLastName() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the last name property for the user, if set.
- getName() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the context's
name
attribute. - getName() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the full name property for the user, if set.
- getName() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Returns the case-sensitive attribute name.
- getPrerequisiteKey() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The key of the prerequisite flag that did not return the desired variation, if the
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - getPrivateAttribute(int) - Method in class com.launchdarkly.sdk.LDContext
-
Retrieves one of the private attribute references that were specified for this context.
- getPrivateAttributeCount() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the number of private attribute references that were specified for this context.
- getPrivateAttributes() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns an enumeration of all attributes that were marked private for this user.
- getReason() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
An object describing the main factor that influenced the flag evaluation value.
- getRuleId() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The unique identifier of the rule that was matched, if the
kind
isEvaluationReason.Kind.RULE_MATCH
. - getRuleIndex() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The index of the rule that was matched (0 for the first rule in the feature flag), if the
kind
isEvaluationReason.Kind.RULE_MATCH
. - getType() - Method in class com.launchdarkly.sdk.LDValue
-
Gets the JSON type for this value.
- getValue() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
The result of the flag evaluation.
- getValue(AttributeRef) - Method in class com.launchdarkly.sdk.LDContext
-
Looks up the value of any attribute of the context, or a value contained within an attribute, based on an
AttributeRef
. - getValue(String) - Method in class com.launchdarkly.sdk.LDContext
-
Looks up the value of any attribute of the context by name.
- getVariationIndex() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
The index of the returned value within the flag's list of variations, e.g.
H
- hashCode() - Method in class com.launchdarkly.sdk.AttributeRef
- hashCode() - Method in class com.launchdarkly.sdk.ContextKind
- hashCode() - Method in class com.launchdarkly.sdk.EvaluationDetail
- hashCode() - Method in class com.launchdarkly.sdk.EvaluationReason
- hashCode() - Method in class com.launchdarkly.sdk.LDContext
- hashCode() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.
- hashCode() - Method in class com.launchdarkly.sdk.LDValue
- hashCode() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.
- HEALTHY - com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that the Big Segment query involved in the flag evaluation was successful, and that the segment state is considered up to date.
I
- Integer - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for integers. - intValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as an
int
if it is numeric. - ip(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the IP for a user.
- IP - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the IP address attribute.
- isAnonymous() - Method in class com.launchdarkly.sdk.LDContext
-
Returns true if this context is only intended for flag evaluations and will not be indexed by LaunchDarkly.
- isAnonymous() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns true if this user was marked anonymous.
- isAttributePrivate(UserAttribute) - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Tests whether an attribute has been marked private for this user.
- isBuiltIn() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Returns true for a built-in attribute or false for a custom attribute.
- isDefault() - Method in class com.launchdarkly.sdk.ContextKind
-
True if this is equal to
ContextKind.DEFAULT
("user"). - isDefaultValue() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
Returns true if the flag evaluation returned the default value, rather than one of the flag's variations.
- isInExperiment() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Whether the evaluation was part of an experiment.
- isInt() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a number that is also an integer.
- isMultiple() - Method in class com.launchdarkly.sdk.LDContext
-
Returns true if this is a multi-kind context.
- isNull() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a null.
- isNumber() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a number (not a numeric string).
- isString() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a string.
- isValid() - Method in class com.launchdarkly.sdk.AttributeRef
-
True for a valid AttributeRef, false for an invalid AttributeRef.
- isValid() - Method in class com.launchdarkly.sdk.LDContext
-
Returns
true
for a valid LDContext,false
for an invalid one.
J
- JsonSerializable - Interface in com.launchdarkly.sdk.json
-
Marker interface for SDK classes that have a custom JSON serialization.
- JsonSerialization - Class in com.launchdarkly.sdk.json
-
Helper methods for JSON serialization of SDK classes.
K
- key(String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's key attribute.
- key(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Changes the user's key.
- KEY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the user key attribute.
- keys() - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the property names in an object.
- kind(ContextKind) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's kind attribute.
- kind(String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's kind attribute, as a string.
L
- LAST_NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the last name attribute.
- lastName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's last name.
- LDContext - Class in com.launchdarkly.sdk
-
A collection of attributes that can be referenced in flag evaluations and analytics events.
- LDGson - Class in com.launchdarkly.sdk.json
-
A helper class for interoperability with application code that uses Gson.
- LDJackson - Class in com.launchdarkly.sdk.json
-
A helper class for interoperability with application code that uses Jackson.
- LDUser - Class in com.launchdarkly.sdk
-
Deprecated.use
LDContext
instead. - LDUser(LDUser.Builder) - Constructor for class com.launchdarkly.sdk.LDUser
-
Deprecated.
- LDUser(String) - Constructor for class com.launchdarkly.sdk.LDUser
-
Deprecated.Create a user with the given key
- LDUser.Builder - Class in com.launchdarkly.sdk
-
Deprecated.
- LDValue - Class in com.launchdarkly.sdk
-
An immutable instance of any data type that is allowed in JSON.
- LDValue() - Constructor for class com.launchdarkly.sdk.LDValue
- LDValue.Convert - Class in com.launchdarkly.sdk
-
Predefined instances of
LDValue.Converter
for commonly used types. - LDValue.Converter<T> - Class in com.launchdarkly.sdk
-
Defines a conversion between
LDValue
and some other type. - LDValueType - Enum in com.launchdarkly.sdk
-
Describes the type of an
LDValue
. - Long - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for long integers. - longValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
long
if it is numeric.
M
- MALFORMED_FLAG - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that there was an internal inconsistency in the flag data, e.g.
- module() - Static method in class com.launchdarkly.sdk.json.LDJackson
-
Returns a Jackson
Module
that defines the correct serialization and deserialization behavior for all LaunchDarkly SDK objects that implementJsonSerializable
. - MULTI - Static variable in class com.launchdarkly.sdk.ContextKind
-
A constant for the kind that all multi-kind contexts have.
- multiBuilder() - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a
ContextMultiBuilder
for building a multi-kind context.
N
- name(String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's name attribute.
- name(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's full name.
- NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the full name attribute.
- NO_VARIATION - Static variable in class com.launchdarkly.sdk.EvaluationDetail
-
If
EvaluationDetail.getVariationIndex()
is equal to this constant, it means no variation was chosen (evaluation failed and returned a default value). - normalize(LDValue) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns the same value if non-null, or
LDValue.ofNull()
if null. - NOT_CONFIGURED - com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that Big Segments could not be queried for the flag evaluation because the SDK configuration did not include a Big Segment store.
- NULL - com.launchdarkly.sdk.LDValueType
-
The value is null.
- NUMBER - com.launchdarkly.sdk.LDValueType
-
The value is numeric.
O
- OBJECT - com.launchdarkly.sdk.LDValueType
-
The value is an object (map).
- ObjectBuilder - Class in com.launchdarkly.sdk
-
A builder created by
LDValue.buildObject()
. - ObjectBuilder() - Constructor for class com.launchdarkly.sdk.ObjectBuilder
- objectFrom(Map<String, T>) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Initializes an
LDValue
as an object, from a map containing this type. - of(boolean) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a boolean value.
- of(double) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(float) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(int) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(long) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(String) - Static method in class com.launchdarkly.sdk.ContextKind
-
Constructor from a string value.
- of(String) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a string value (or a null).
- off() - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.OFF
. - OFF - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag was off and therefore returned its configured off value.
- ofNull() - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a null value.
P
- parse(String) - Static method in class com.launchdarkly.sdk.LDValue
-
Parses an LDValue from a JSON representation.
- PREREQUISITE_FAILED - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag was considered off because it had at least one prerequisite flag that either was off or did not return the desired variation.
- prerequisiteFailed(String) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - privateAttributes(AttributeRef...) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Equivalent to
ContextBuilder.privateAttributes(String...)
, but uses theAttributeRef
type. - privateAttributes(String...) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Designates any number of context attributes, or properties within them, as private: that is, their values will not be recorded by LaunchDarkly.
- privateAvatar(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's avatar, and ensures that the avatar attribute will not be sent back to LaunchDarkly.
- privateCountry(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Set the country for a user, and ensures that the country attribute will not be sent back to LaunchDarkly.
- privateCustom(String, boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a boolean-valued custom attribute that will not be sent back to LaunchDarkly.
- privateCustom(String, double) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a double-precision numeric custom attribute that will not be sent back to LaunchDarkly.
- privateCustom(String, int) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add an int-valued custom attribute that will not be sent back to LaunchDarkly.
- privateCustom(String, LDValue) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a custom attribute of any JSON type, that will not be sent back to LaunchDarkly.
- privateCustom(String, String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a
String
-valued custom attribute that will not be sent back to LaunchDarkly. - privateEmail(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's e-mail address, and ensures that the e-mail address attribute will not be sent back to LaunchDarkly.
- privateFirstName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's first name, and ensures that the first name attribute will not be sent back to LaunchDarkly.
- privateIp(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the IP for a user, and ensures that the IP attribute is not sent back to LaunchDarkly.
- privateLastName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's last name, and ensures that the last name attribute will not be sent back to LaunchDarkly.
- privateName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's full name, and ensures that the name attribute will not be sent back to LaunchDarkly.
- put(String, boolean) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, double) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, float) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, int) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, long) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, LDValue) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, String) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
R
- RULE_MATCH - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the context matched one of the flag's rules.
- ruleMatch(int, String) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.RULE_MATCH
. - ruleMatch(int, String, boolean) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.RULE_MATCH
and where the inExperiment parameter represents whether the evaluation was part of an experiment.
S
- SerializationException - Exception in com.launchdarkly.sdk.json
-
General exception class for all errors in serializing or deserializing JSON.
- SerializationException(String) - Constructor for exception com.launchdarkly.sdk.json.SerializationException
-
Creates an instance.
- SerializationException(Throwable) - Constructor for exception com.launchdarkly.sdk.json.SerializationException
-
Creates an instance.
- serialize(T) - Static method in class com.launchdarkly.sdk.json.JsonSerialization
-
Converts an object to its JSON representation.
- set(String, boolean) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for a boolean value. - set(String, double) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for a double-precision numeric value. - set(String, int) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for an integer numeric value. - set(String, LDValue) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the value of any attribute for the context.
- set(String, String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for a string value. - size() - Method in class com.launchdarkly.sdk.LDValue
-
Returns the number of elements in an array or object.
- STALE - com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that the Big Segment query involved in the flag evaluation was successful, but that the segment state may not be up to date.
- STORE_ERROR - com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that the Big Segment query involved in the flag evaluation failed, for instance due to a database error.
- String - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for strings. - STRING - com.launchdarkly.sdk.LDValueType
-
The value is a string.
- stringValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
String
if it is a string.
T
- TARGET_MATCH - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the context key was specifically targeted for this flag.
- targetMatch() - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.TARGET_MATCH
. - toJsonString() - Method in class com.launchdarkly.sdk.LDValue
-
Converts this value to its JSON serialization.
- toString() - Method in class com.launchdarkly.sdk.AttributeRef
-
Returns the attribute reference as a string, in the same format used by
AttributeRef.fromPath(String)
. - toString() - Method in class com.launchdarkly.sdk.ContextKind
-
Returns the string value of the context kind.
- toString() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
Returns a simple string representation of this instance.
- toString() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns a simple string representation of the reason.
- toString() - Method in class com.launchdarkly.sdk.LDContext
-
Returns a string representation of the context.
- toString() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.
- toString() - Method in class com.launchdarkly.sdk.LDValue
-
Returns a string representation of this value.
- toString() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.
- toType(LDValue) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Converts an
LDValue
to a value of the specified type. - trySet(String, LDValue) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
, but returns a boolean indicating whether the attribute was successfully set. - typeAdapters() - Static method in class com.launchdarkly.sdk.json.LDGson
-
Returns a Gson
TypeAdapterFactory
that defines the correct serialization and deserialization behavior for all LaunchDarkly SDK objects that implementJsonSerializable
.
U
- USER_NOT_SPECIFIED - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the caller passed
null
for the user parameter, or the user lacked a key. - UserAttribute - Class in com.launchdarkly.sdk
V
- valueMapToJsonElementMap(Map<T, LDValue>) - Static method in class com.launchdarkly.sdk.json.LDGson
-
Convenience method for converting a map of
LDValue
values to a map of GsonJsonElement
s. - valueOf(String) - Static method in enum com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.EvaluationReason.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.LDValueType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.launchdarkly.sdk.EvaluationReason.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the values in an array or object.
- values() - Static method in enum com.launchdarkly.sdk.LDValueType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- valuesAs(LDValue.Converter<T>) - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the values in an array or object, converting them to a specific type.
- valueToJsonElement(LDValue) - Static method in class com.launchdarkly.sdk.json.LDGson
-
Returns a Gson
JsonElement
that is equivalent to the specifiedLDValue
.
W
- withBigSegmentsStatus(EvaluationReason.BigSegmentsStatus) - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns a copy of this
EvaluationReason
with a specificEvaluationReason.BigSegmentsStatus
value. - WRONG_TYPE - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the result value was not of the requested type, e.g.
All Classes All Packages