io.orchestrate.client

Class KvObject<T>

java.lang.Object

io.orchestrate.client.KvObject<T>

Type Parameters:

T - The deserializable type for the value of this KV object.

All Implemented Interfaces:

KvMetadata

Direct Known Subclasses:

Event

public class KvObject<T>
extends java.lang.Object
implements KvMetadata

A container for a KV object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCollection() Returns the collection this metadata belongs to.
java.lang.String	getKey() Returns the key of this metadata.
java.lang.String	getRawValue() Returns the raw JSON value of this KV object.
java.lang.String	getRef() Returns the reference (i.e.
T	getValue() Returns the value of this KV object.
<T> T	getValue(java.lang.Class<T> clazz) Returns the value of this KV object, mapped to the provided Class.

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public final T getValue()

Returns the value of this KV object.

Returns:

The value of the KV object, may be null.

getValue

public <T> T getValue(java.lang.Class<T> clazz)

Returns the value of this KV object, mapped to the provided Class. This is useful in cases where results may be of mixed types (eg if a search request includes items and events). The original value json will be deserialized to the provided type.

To get the value as the raw json, call with String.class

 String json = kv.getValue(String.class);
 
 

 

 This is equivalent to calling getRawValue. Other common use cases are
 Map.class (to just get the json as a nested hashmap), or a POJO class
 of your own (for example a simple User java bean class).
 

Returns:

The value of the KV object, may be null.

getRawValue

public final java.lang.String getRawValue()

Returns the raw JSON value of this KV object.

Returns:

The raw JSON value of this KV object, may be null.

getCollection

public java.lang.String getCollection()

Description copied from interface: KvMetadata

Returns the collection this metadata belongs to.

Specified by:

getCollection in interface KvMetadata

Returns:

The collection of this metadata.

getKey

public java.lang.String getKey()

Description copied from interface: KvMetadata

Returns the key of this metadata.

Specified by:

getKey in interface KvMetadata

Returns:

The key for this metadata.

getRef

public java.lang.String getRef()

Description copied from interface: KvMetadata

Returns the reference (i.e. "version") of this metadata.

Specified by:

getRef in interface KvMetadata

Returns:

The reference for this metadata.