Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ALL - Enum constant in enum class growthbook.sdk.java.Operator
-
$all
- ARRAY - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is an array
B
- BOOLEAN - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is a boolean
- BucketRange - Class in growthbook.sdk.java
-
A tuple that describes a range of the number line between 0 and 1.
- BucketRange() - Constructor for class growthbook.sdk.java.BucketRange
- builder() - Static method in class growthbook.sdk.java.GBContext
-
The builder class to help create a context.
C
- clearCallbacks() - Method in class growthbook.sdk.java.GBFeaturesRepository
- CONFIGURATION_ERROR - Enum constant in enum class growthbook.sdk.java.FeatureFetchException.FeatureFetchErrorCode
-
- an encryptionKey was provided but the endpoint does not support encryption so decryption fails - no features were found for an unencrypted endpoint
D
- DataType - Enum Class in growthbook.sdk.java
-
A data type class used internally to help evaluate conditions
- DEFAULT_VALUE - Enum constant in enum class growthbook.sdk.java.FeatureResultSource
-
When the value is assigned due to a default value condition
- destroy() - Method in class growthbook.sdk.java.GrowthBook
E
- ELEMENT_MATCH - Enum constant in enum class growthbook.sdk.java.Operator
-
$elemMatch
- EQ - Enum constant in enum class growthbook.sdk.java.Operator
-
$eq
- equals(Object) - Method in class growthbook.sdk.java.BucketRange
- evalFeature(String, Class<ValueType>) - Method in class growthbook.sdk.java.GrowthBook
- evaluateCondition(String, String) - Method in class growthbook.sdk.java.GrowthBook
- EXISTS - Enum constant in enum class growthbook.sdk.java.Operator
-
$exists
- Experiment<ValueType> - Class in growthbook.sdk.java
-
Defines a single Experiment
- Experiment() - Constructor for class growthbook.sdk.java.Experiment
- EXPERIMENT - Enum constant in enum class growthbook.sdk.java.FeatureResultSource
-
When the value is assigned due to an experiment condition
- ExperimentResult<ValueType> - Class in growthbook.sdk.java
-
The result of an
GrowthBook.run(Experiment)
call - ExperimentResult(ValueType, Integer, Boolean, String, String, String, Boolean, String, String, Float, Boolean) - Constructor for class growthbook.sdk.java.ExperimentResult
-
The result of running an
Experiment
given a specificGBContext
- ExperimentRunCallback - Interface in growthbook.sdk.java
-
A callback to be executed with an
ExperimentResult
whenever an experiment is run.
F
- Feature<ValueType> - Class in growthbook.sdk.java
-
The feature with a generic value type.
- Feature() - Constructor for class growthbook.sdk.java.Feature
- FeatureFetchException - Exception in growthbook.sdk.java
-
This error is thrown by
GBFeaturesRepository
You can call getErrorCode() to get an enum of various error types you can handle. - FeatureFetchException(FeatureFetchException.FeatureFetchErrorCode) - Constructor for exception growthbook.sdk.java.FeatureFetchException
-
Create an exception with error code
- FeatureFetchException(FeatureFetchException.FeatureFetchErrorCode, String) - Constructor for exception growthbook.sdk.java.FeatureFetchException
-
Create an exception with error code and custom message
- FeatureFetchException.FeatureFetchErrorCode - Enum Class in growthbook.sdk.java
-
Error codes available for a
FeatureFetchException
- FeatureRefreshCallback - Interface in growthbook.sdk.java
- FeatureRefreshStrategy - Enum Class in growthbook.sdk.java
- FeatureResult<ValueType> - Class in growthbook.sdk.java
-
Results for a
IFeatureEvaluator.evaluateFeature(String, GBContext, Class)
value (any) - The assigned value of the feature on (boolean) - The assigned value cast to a boolean off (boolean) - The assigned value cast to a boolean and then negated source (enum) - One of "unknownFeature", "defaultValue", "force", or "experiment" experiment (Experiment or null) - When source is "experiment", this will be an Experiment object experimentResult (ExperimentResult or null) - When source is "experiment", this will be an ExperimentResult object - FeatureResult() - Constructor for class growthbook.sdk.java.FeatureResult
- FeatureResultSource - Enum Class in growthbook.sdk.java
-
An enum of the possible sources for the feature result
- FeatureRule<ValueType> - Class in growthbook.sdk.java
-
Overrides the defaultValue of a Feature based on a set of requirements.
- FeatureRule() - Constructor for class growthbook.sdk.java.FeatureRule
- FeatureUsageCallback - Interface in growthbook.sdk.java
-
Listen for feature usage events
- Filter - Class in growthbook.sdk.java
-
Object used for mutual exclusion and filtering users out of experiments based on random hashes.
- Filter(String, List<BucketRange>, String, Integer) - Constructor for class growthbook.sdk.java.Filter
-
Object used for mutual exclusion and filtering users out of experiments based on random hashes.
- FORCE - Enum constant in enum class growthbook.sdk.java.FeatureResultSource
-
When the value is assigned due to a forced condition
- fromString(String) - Static method in enum class growthbook.sdk.java.FeatureResultSource
-
Get a nullable enum Operator from the string value.
- fromString(String) - Static method in enum class growthbook.sdk.java.Operator
-
Get a nullable enum Operator from the string value.
G
- GBContext - Class in growthbook.sdk.java
-
Context object passed into the GrowthBook constructor.
- GBContext(String, String, String, Boolean, Boolean, String, Boolean, Map<String, Integer>, TrackingCallback, FeatureUsageCallback) - Constructor for class growthbook.sdk.java.GBContext
-
The
GBContext.GBContextBuilder
is recommended for constructing a Context. - GBContext.GBContextBuilder - Class in growthbook.sdk.java
-
The builder class to help create a context.
- GBContextBuilder() - Constructor for class growthbook.sdk.java.GBContext.GBContextBuilder
- GBFeaturesRepository - Class in growthbook.sdk.java
-
This class can be created with its `builder()` or constructor.
- GBFeaturesRepository(String, String, String, FeatureRefreshStrategy, Integer) - Constructor for class growthbook.sdk.java.GBFeaturesRepository
-
Create a new GBFeaturesRepository
- GBFeaturesRepository(String, String, String, FeatureRefreshStrategy, Integer, OkHttpClient) - Constructor for class growthbook.sdk.java.GBFeaturesRepository
-
Create a new GBFeaturesRepository
- GBFeaturesRepositoryRequestInterceptor - Class in growthbook.sdk.java
-
Appends User-Agent info to the request headers.
- GBFeaturesRepositoryRequestInterceptor() - Constructor for class growthbook.sdk.java.GBFeaturesRepositoryRequestInterceptor
- getDefaultValue() - Method in class growthbook.sdk.java.Feature
-
The default value for a feature evaluation
- getDeserializer() - Static method in class growthbook.sdk.java.BucketRange
- getDeserializer() - Static method in class growthbook.sdk.java.Namespace
-
Deprecated.a Gson deserializer for
Namespace
- getFeaturesJson() - Method in class growthbook.sdk.java.GBFeaturesRepository
- getFeatureValue(String, Boolean) - Method in class growthbook.sdk.java.GrowthBook
- getFeatureValue(String, Double) - Method in class growthbook.sdk.java.GrowthBook
- getFeatureValue(String, Float) - Method in class growthbook.sdk.java.GrowthBook
- getFeatureValue(String, Integer) - Method in class growthbook.sdk.java.GrowthBook
- getFeatureValue(String, Object) - Method in class growthbook.sdk.java.GrowthBook
- getFeatureValue(String, String) - Method in class growthbook.sdk.java.GrowthBook
- getFeatureValue(String, ValueType, Class<ValueType>) - Method in class growthbook.sdk.java.GrowthBook
- getJson(Experiment<ValueType>) - Static method in class growthbook.sdk.java.Experiment
-
Get a Gson JsonElement of the experiment
- getJson(FeatureResult<ValueType>) - Static method in class growthbook.sdk.java.FeatureResult
-
Get a Gson JsonElement of the
FeatureResult
- getRules() - Method in class growthbook.sdk.java.Feature
-
Returns the rules for evaluating the feature
- getSerializer() - Static method in class growthbook.sdk.java.BucketRange
- getSerializer() - Static method in class growthbook.sdk.java.FeatureResult
-
a Gson serializer for
FeatureResult
- getSerializer() - Static method in class growthbook.sdk.java.Namespace
-
Deprecated.a Gson serializer for
Namespace
- GrowthBook - Class in growthbook.sdk.java
-
GrowthBook SDK class.
- GrowthBook() - Constructor for class growthbook.sdk.java.GrowthBook
-
No-args constructor.
- GrowthBook(GBContext) - Constructor for class growthbook.sdk.java.GrowthBook
-
Initialize the GrowthBook SDK with a provided
GBContext
- growthbook.sdk.java - package growthbook.sdk.java
- GT - Enum constant in enum class growthbook.sdk.java.Operator
-
$gt
- GTE - Enum constant in enum class growthbook.sdk.java.Operator
-
$gte
H
- hashCode() - Method in class growthbook.sdk.java.BucketRange
I
- IN - Enum constant in enum class growthbook.sdk.java.Operator
-
$in
- initialize() - Method in class growthbook.sdk.java.GBFeaturesRepository
- intercept(Interceptor.Chain) - Method in class growthbook.sdk.java.GBFeaturesRepositoryRequestInterceptor
- isOff() - Method in class growthbook.sdk.java.FeatureResult
-
Evaluates to true when the feature is off
- isOff(String) - Method in class growthbook.sdk.java.GrowthBook
- isOn() - Method in class growthbook.sdk.java.FeatureResult
-
Evaluates to true when the feature is on
- isOn(String) - Method in class growthbook.sdk.java.GrowthBook
L
- LT - Enum constant in enum class growthbook.sdk.java.Operator
-
$lt
- LTE - Enum constant in enum class growthbook.sdk.java.Operator
-
$lte
N
- Namespace - Class in growthbook.sdk.java
-
Deprecated.
- Namespace() - Constructor for class growthbook.sdk.java.Namespace
-
Deprecated.
- NE - Enum constant in enum class growthbook.sdk.java.Operator
-
$ne
- NIN - Enum constant in enum class growthbook.sdk.java.Operator
-
$nin
- NO_RESPONSE_ERROR - Enum constant in enum class growthbook.sdk.java.FeatureFetchException.FeatureFetchErrorCode
-
- there was no response body
- NOT - Enum constant in enum class growthbook.sdk.java.Operator
-
$not
- NULL - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is a JSON null
- NUMBER - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is a number
O
- OBJECT - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is an object
- onError(Throwable) - Method in interface growthbook.sdk.java.FeatureRefreshCallback
- onFeaturesRefresh(FeatureRefreshCallback) - Method in class growthbook.sdk.java.GBFeaturesRepository
-
Subscribe to feature refresh events This callback is called when the features are successfully refreshed or there is an error when refreshing.
- onFeatureUsage(String, FeatureResult<ValueType>) - Method in interface growthbook.sdk.java.FeatureUsageCallback
- onRefresh(String) - Method in interface growthbook.sdk.java.FeatureRefreshCallback
- onRun(ExperimentResult) - Method in interface growthbook.sdk.java.ExperimentRunCallback
-
A callback to be executed with an
ExperimentResult
whenever an experiment is run. - onTrack(Experiment<ValueType>, ExperimentResult<ValueType>) - Method in interface growthbook.sdk.java.TrackingCallback
-
This callback is called with the
Experiment
andExperimentResult
when an experiment is evaluated. - Operator - Enum Class in growthbook.sdk.java
-
Operator for use in the condition JSON
P
- paddedVersionString(String) - Static method in class growthbook.sdk.java.StringUtils
- padLeftZeros(String, Integer) - Static method in class growthbook.sdk.java.StringUtils
R
- REGEX - Enum constant in enum class growthbook.sdk.java.Operator
-
$regex
- run(Experiment<ValueType>) - Method in class growthbook.sdk.java.GrowthBook
S
- SERVER_SENT_EVENTS - Enum constant in enum class growthbook.sdk.java.FeatureRefreshStrategy
- setAttributes(String) - Method in class growthbook.sdk.java.GrowthBook
- setAttributesJson(String) - Method in class growthbook.sdk.java.GBContext
-
You can update the attributes JSON with new user attributes to evaluate against.
- setFeatures(String) - Method in class growthbook.sdk.java.GrowthBook
- setFeaturesJson(String) - Method in class growthbook.sdk.java.GBContext
-
You can update the features JSON with new features to evaluate against.
- SIZE - Enum constant in enum class growthbook.sdk.java.Operator
-
$size
- SSE_CONNECTION_ERROR - Enum constant in enum class growthbook.sdk.java.FeatureFetchException.FeatureFetchErrorCode
-
- could not establish a connection to the events (server-sent events) for feature updates
- STALE_WHILE_REVALIDATE - Enum constant in enum class growthbook.sdk.java.FeatureRefreshStrategy
- STRING - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is a string
- StringUtils - Class in growthbook.sdk.java
- StringUtils() - Constructor for class growthbook.sdk.java.StringUtils
- subscribe(ExperimentRunCallback) - Method in class growthbook.sdk.java.GrowthBook
T
- toJson() - Method in class growthbook.sdk.java.BucketRange
-
Converts the bucket range to the serialized tuple
- toJson() - Method in class growthbook.sdk.java.Experiment
-
Get a Gson JsonElement of the experiment
- toJson() - Method in class growthbook.sdk.java.ExperimentResult
-
Serialized JSON string of the
ExperimentResult
- toJson() - Method in class growthbook.sdk.java.FeatureResult
-
Get a Gson JsonElement of the
FeatureResult
- toJson() - Method in class growthbook.sdk.java.Filter
- toJson() - Method in class growthbook.sdk.java.Namespace
-
Deprecated.A JSON string for the namespace, resulting in a triple value [id, rangeStart, rangeEnd]
- toString() - Method in class growthbook.sdk.java.BucketRange
- toString() - Method in enum class growthbook.sdk.java.DataType
- toString() - Method in class growthbook.sdk.java.Experiment
- toString() - Method in enum class growthbook.sdk.java.FeatureResultSource
- toString() - Method in class growthbook.sdk.java.Filter
- toString() - Method in class growthbook.sdk.java.Namespace
-
Deprecated.
- toString() - Method in enum class growthbook.sdk.java.Operator
- TrackData<ValueType> - Class in growthbook.sdk.java
-
Used for remote feature evaluation to trigger the
TrackingCallback
- TrackData() - Constructor for class growthbook.sdk.java.TrackData
- TrackingCallback - Interface in growthbook.sdk.java
-
This callback is called with the
Experiment
andExperimentResult
when an experiment is evaluated. - TYPE - Enum constant in enum class growthbook.sdk.java.Operator
-
$type
U
- UNDEFINED - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is not present, e.g.
- UNKNOWN - Enum constant in enum class growthbook.sdk.java.DataType
-
when the type is unknown.
- UNKNOWN - Enum constant in enum class growthbook.sdk.java.FeatureFetchException.FeatureFetchErrorCode
-
- there was an unknown error that occurred when attempting to make the request.
- UNKNOWN_FEATURE - Enum constant in enum class growthbook.sdk.java.FeatureResultSource
-
When the feature is unknown
- URL_OVERRIDE - Enum constant in enum class growthbook.sdk.java.FeatureResultSource
-
When the value is assigned due to forced feature assignment via the URL
V
- valueOf(String) - Static method in enum class growthbook.sdk.java.DataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class growthbook.sdk.java.FeatureFetchException.FeatureFetchErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class growthbook.sdk.java.FeatureRefreshStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class growthbook.sdk.java.FeatureResultSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class growthbook.sdk.java.Operator
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class growthbook.sdk.java.DataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class growthbook.sdk.java.FeatureFetchException.FeatureFetchErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class growthbook.sdk.java.FeatureRefreshStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class growthbook.sdk.java.FeatureResultSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class growthbook.sdk.java.Operator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VariationMeta - Class in growthbook.sdk.java
-
Meta info about an experiment variation
- VariationMeta() - Constructor for class growthbook.sdk.java.VariationMeta
- Version - Class in growthbook.sdk.java
-
Tag for the published GrowthBook SDK version
- VERSION_EQ - Enum constant in enum class growthbook.sdk.java.Operator
-
$veq
- VERSION_GT - Enum constant in enum class growthbook.sdk.java.Operator
-
$vgt
- VERSION_GTE - Enum constant in enum class growthbook.sdk.java.Operator
-
$vgte
- VERSION_LT - Enum constant in enum class growthbook.sdk.java.Operator
-
$vlt
- VERSION_LTE - Enum constant in enum class growthbook.sdk.java.Operator
-
$vlte
- VERSION_NE - Enum constant in enum class growthbook.sdk.java.Operator
-
$vne
All Classes and Interfaces|All Packages|Serialized Form