com.launchdarkly.client

Class VersionedDataKind<T extends VersionedData>

java.lang.Object

com.launchdarkly.client.VersionedDataKind<T>

Type Parameters:

T - the item type

public abstract class VersionedDataKind<T extends VersionedData>
extends java.lang.Object

The descriptor for a specific kind of VersionedData objects that may exist in a FeatureStore. You will not need to refer to this type unless you are directly manipulating a FeatureStore or writing your own FeatureStore implementation. If you are implementing a custom store, for maximum forward compatibility you should only refer to VersionedData, VersionedDataKind, and ALL, and avoid any dependencies on specific type descriptor instances or any specific fields of the types they describe.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Iterable<VersionedDataKind<?>>	ALL A list of all existing instances of VersionedDataKind.
static VersionedDataKind<com.launchdarkly.client.FeatureFlag>	FEATURES The VersionedDataKind instance that describes feature flag data.
static VersionedDataKind<com.launchdarkly.client.Segment>	SEGMENTS The VersionedDataKind instance that describes user segment data.

Constructor Summary

Constructors

Constructor and Description
VersionedDataKind()

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.String>	getDependencyKeys(VersionedData item) Gets all keys of items that this one directly depends on, if this kind of item can have dependencies.
abstract java.lang.Class<T>	getItemClass() The Java class for objects of this type.
abstract java.lang.String	getNamespace() A short string that serves as the unique name for the collection of these objects, e.g.
int	getPriority() Used internally to determine the order in which collections are updated.
abstract java.lang.String	getStreamApiPath() The path prefix for objects of this type in events received from the streaming API.
boolean	isDependencyOrdered() Returns true if the SDK needs to store items of this kind in an order that is based on getDependencyKeys(VersionedData).
abstract T	makeDeletedItem(java.lang.String key, int version) Return an instance of this type with the specified key and version, and deleted=true.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FEATURES

public static VersionedDataKind<com.launchdarkly.client.FeatureFlag> FEATURES

The VersionedDataKind instance that describes feature flag data.

SEGMENTS

public static VersionedDataKind<com.launchdarkly.client.Segment> SEGMENTS

The VersionedDataKind instance that describes user segment data.

ALL

public static java.lang.Iterable<VersionedDataKind<?>> ALL

A list of all existing instances of VersionedDataKind.

Since:

4.1.0

Constructor Detail

VersionedDataKind

public VersionedDataKind()

Method Detail

getNamespace

public abstract java.lang.String getNamespace()

A short string that serves as the unique name for the collection of these objects, e.g. "features".

Returns:

a namespace string

getItemClass

public abstract java.lang.Class<T> getItemClass()

The Java class for objects of this type.

Returns:

a Java class

getStreamApiPath

public abstract java.lang.String getStreamApiPath()

The path prefix for objects of this type in events received from the streaming API.

Returns:

the URL path

makeDeletedItem

public abstract T makeDeletedItem(java.lang.String key,
                                  int version)

Return an instance of this type with the specified key and version, and deleted=true.

Parameters:

key - the unique key

version - the version number

Returns:

a new instance

getPriority

public int getPriority()

Used internally to determine the order in which collections are updated. The default value is arbitrary; the built-in data kinds override it for specific data model reasons.

Returns:

a zero-based integer; collections with a lower priority are updated first

Since:

4.7.0

isDependencyOrdered

public boolean isDependencyOrdered()

Returns true if the SDK needs to store items of this kind in an order that is based on getDependencyKeys(VersionedData).

Returns:

true if dependency ordering should be used

Since:

4.7.0

getDependencyKeys

public java.lang.Iterable<java.lang.String> getDependencyKeys(VersionedData item)

Gets all keys of items that this one directly depends on, if this kind of item can have dependencies.

Note that this does not use the generic type T, because it is called from code that only knows about VersionedData, so it will need to do a type cast. However, it can rely on the item being of the correct class.

Parameters:

item - the item

Returns:

keys of dependencies of the item

Since:

4.7.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object