ome.smuggler.core.msg

Class ChannelMessage<M,D>

java.lang.Object

ome.smuggler.core.msg.ChannelMessage<M,D>

public class ChannelMessage<M,D>
extends java.lang.Object

Imposes a minimal structure to a message exchanged on a channel. This represents a common use case where the data to be consumed by the receiving end is possibly accompanied by metadata. Typically metadata is used to configure the sending of a message and/or to specify additional message properties.

Constructor Summary

Constructors

Constructor and Description
ChannelMessage(D data) Creates a new instance with no metadata.
ChannelMessage(M metadata, D data) Creates a new instance.
ChannelMessage(java.util.Optional<M> metadata, D data) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
D	data()
boolean	equals(java.lang.Object x)
int	hashCode()
static <M,D> ChannelMessage<M,D>	message(D data) Syntactic sugar for the one-argument constructor.
static <M,D> ChannelMessage<M,D>	message(M metadata, D data) Syntactic sugar for the two-argument constructor.
static <M,D> ChannelMessage<M,D>	message(java.util.Optional<M> metadata, D data) Syntactic sugar for the two-argument constructor.
java.util.Optional<M>	metadata()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelMessage

public ChannelMessage(java.util.Optional<M> metadata,
                      D data)

Creates a new instance.

Parameters:

metadata - any metadata accompanying the data to consume.

data - the data to consume.

Throws:

java.lang.NullPointerException - if any argument is null.

ChannelMessage

public ChannelMessage(M metadata,
                      D data)

Creates a new instance.

Parameters:

metadata - any metadata accompanying the data to consume.

data - the data to consume.

Throws:

java.lang.NullPointerException - if any argument is null.

ChannelMessage

public ChannelMessage(D data)

Creates a new instance with no metadata.

Parameters:

data - the data to consume.

Throws:

java.lang.NullPointerException - if the argument is null.

Method Detail

message

public static <M,D> ChannelMessage<M,D> message(java.util.Optional<M> metadata,
                                                D data)

Syntactic sugar for the two-argument constructor.

Type Parameters:

M - the metadata type.

D - the data type.

Parameters:

metadata - the optional metadata.

data - the data.

Returns:

a new instance.

message

public static <M,D> ChannelMessage<M,D> message(M metadata,
                                                D data)

Syntactic sugar for the two-argument constructor.

Type Parameters:

M - the metadata type.

D - the data type.

Parameters:

metadata - the metadata.

data - the data.

Returns:

a new instance.

message

public static <M,D> ChannelMessage<M,D> message(D data)

Syntactic sugar for the one-argument constructor.

Type Parameters:

M - the metadata type.

D - the data type.

Parameters:

data - the data.

Returns:

a new instance.

metadata

public java.util.Optional<M> metadata()

Returns:

any metadata accompanying the data to consume or empty if the sender specified no metadata.

data

public D data()

Returns:

the data to consume.

equals

public boolean equals(java.lang.Object x)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object