Package org.apache.pulsar.common.schema

Class KeyValue<K,V>

java.lang.Object

org.apache.pulsar.common.schema.KeyValue<K,V>

@Public
@Stable
public class KeyValue<K,V>
extends Object

A simple KeyValue class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyValue.KeyValueDecoder<K,V>	Decoder to decode key/value bytes.

Constructor Summary

Constructors

Constructor	Description
KeyValue(K key, V value)

Method Summary

Modifier and Type	Method	Description
static <K, V> KeyValue<K,V>	decode(byte[] data, KeyValue.KeyValueDecoder<K,V> decoder)	Decode the value into a key/value pair.
static <K, V> EncodeData	encode(String topic, K key, Schema<K> keyWriter, V value, Schema<V> valueWriter)
static <K, V> byte[]	encode(K key, Schema<K> keyWriter, V value, Schema<V> valueWriter)	Encode a key and value pair into a bytes array.
boolean	equals(Object obj)
static byte[]	generateKVSchemaId(byte[] keySchemaId, byte[] valueSchemaId)	Generate a combined schema id for key/value schema.
K	getKey()
static KeyValue<byte[],byte[]>	getSchemaId(byte[] schemaId)
V	getValue()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KeyValue

public KeyValue(K key,
 V value)

Method Details

getKey

public K getKey()

getValue

public V getValue()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

encode

public static <K,
V> byte[] encode(K key,
 Schema<K> keyWriter,
 V value,
 Schema<V> valueWriter)

Encode a key and value pair into a bytes array.

Parameters:

key - key object to encode

keyWriter - a writer to encode key object

value - value object to encode

valueWriter - a writer to encode value object

Returns:

the encoded bytes array

encode

public static <K,
V> EncodeData encode(String topic,
 K key,
 Schema<K> keyWriter,
 V value,
 Schema<V> valueWriter)

generateKVSchemaId

public static byte[] generateKVSchemaId(byte[] keySchemaId,
 byte[] valueSchemaId)

Generate a combined schema id for key/value schema. The format is: schemaId = schemaKeyLength + keySchemaIdBytes + schemaValueLength + valueSchemaIdBytes where schemaKeyLength and schemaValueLength are 4 bytes integer. If keySchemaIdBytes or valueSchemaIdBytes is null, the length will be 0. So the total length of schemaId is: 4 + keySchemaIdBytes.length + 4 + valueSchemaIdBytes.length

Parameters:

keySchemaId - the schema id of key schema

valueSchemaId - the schema id of value schema

getSchemaId

public static KeyValue<byte[],byte[]> getSchemaId(byte[] schemaId)

decode

public static <K,
V> KeyValue<K,V> decode(byte[] data,
 KeyValue.KeyValueDecoder<K,V> decoder)

Decode the value into a key/value pair.

Parameters:

data - the encoded bytes

decoder - the decoder to decode encoded key/value bytes

Returns:

the decoded key/value pair