org.nuxeo.lib.stream.pattern

Class KeyValueMessage

java.lang.Object

org.nuxeo.lib.stream.pattern.KeyValueMessage

All Implemented Interfaces:

Externalizable, Serializable, Message

public class KeyValueMessage
extends Object
implements Message

Simple key value message.

Since:

9.1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	forceBatch
protected String	key
static KeyValueMessage	POISON_PILL
protected boolean	poisonPill
protected byte[]	value

Constructor Summary

Constructors

Modifier	Constructor and Description
	KeyValueMessage()
protected	KeyValueMessage(String key, byte[] value, boolean poisonPill, boolean forceBatch)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
boolean	forceBatch() A consumer reading this message must not wait for new message to process the batch.
String	getId() A message identifier.
int	hashCode()
String	key()
static KeyValueMessage	of(String key)
static KeyValueMessage	of(String key, byte[] value)
static KeyValueMessage	ofForceBatch(String key)
static KeyValueMessage	ofForceBatch(String key, byte[] value) A message that force the batch.
boolean	poisonPill() This message is a poison pill it contains no other data, a consumer reading this message will process the batch and stop.
void	readExternal(ObjectInput in)
String	toString()
byte[]	value()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

POISON_PILL

public static final KeyValueMessage POISON_PILL

key

protected String key

value

protected byte[] value

poisonPill

protected boolean poisonPill

forceBatch

protected boolean forceBatch

Constructor Detail

KeyValueMessage

public KeyValueMessage()

KeyValueMessage

protected KeyValueMessage(String key,
                          byte[] value,
                          boolean poisonPill,
                          boolean forceBatch)

Method Detail

of

public static KeyValueMessage of(String key,
                                 byte[] value)

of

public static KeyValueMessage of(String key)

ofForceBatch

public static KeyValueMessage ofForceBatch(String key,
                                           byte[] value)

A message that force the batch.

ofForceBatch

public static KeyValueMessage ofForceBatch(String key)

key

public String key()

value

public byte[] value()

getId

public String getId()

Description copied from interface: Message

A message identifier.

Specified by:

getId in interface Message

poisonPill

public boolean poisonPill()

Description copied from interface: Message

This message is a poison pill it contains no other data, a consumer reading this message will process the batch and stop.

Specified by:

poisonPill in interface Message

forceBatch

public boolean forceBatch()

Description copied from interface: Message

A consumer reading this message must not wait for new message to process the batch.

Specified by:

forceBatch in interface Message

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object