com.github.ddth.queue

Interface IQueueMessage

All Superinterfaces:

Cloneable

All Known Implementing Classes:

BaseUniversalQueueMessage, IQueueMessage.EmptyQueueMessage, UniversalQueueMessage, UniversalQueueMessage

public interface IQueueMessage
extends Cloneable

Represents a queue message.

Since:

0.1.0

Author:

Thanh Ba Nguyen

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IQueueMessage.EmptyQueueMessage An empty queue message.

Method Summary

Modifier and Type	Method and Description
IQueueMessage	clone() Clones this message.
Object	qData() Data/content attached to the queue message.
IQueueMessage	qData(Object data) Attaches data/content to the queue message.
Object	qId() Message's unique id in queue.
IQueueMessage	qId(Object queueId) Sets message's unique queue id.
IQueueMessage	qIncNumRequeues() Increases message's number of re-queue times by 1.
int	qNumRequeues() How many times message has been re-queued?
IQueueMessage	qNumRequeues(int numRequeues) Sets message's number of re-queue times.
Date	qOriginalTimestamp() Message's first-queued timestamp.
IQueueMessage	qOriginalTimestamp(Date timestamp) Sets message's first-queued timestamp.
Date	qTimestamp() Message's last-queued timestamp.
IQueueMessage	qTimestamp(Date timestamp) Sets message's last-queued timestamp.

Method Detail

clone

IQueueMessage clone()

Clones this message.

Returns:

Since:

0.4.0

qId

Object qId()

Message's unique id in queue.

Returns:

qId

IQueueMessage qId(Object queueId)

Sets message's unique queue id.

Parameters:

id -

Returns:

qOriginalTimestamp

Date qOriginalTimestamp()

Message's first-queued timestamp.

Returns:

qOriginalTimestamp

IQueueMessage qOriginalTimestamp(Date timestamp)

Sets message's first-queued timestamp.

Parameters:

timestamp -

Returns:

qTimestamp

Date qTimestamp()

Message's last-queued timestamp.

Returns:

qTimestamp

IQueueMessage qTimestamp(Date timestamp)

Sets message's last-queued timestamp.

Parameters:

timestamp -

Returns:

qNumRequeues

int qNumRequeues()

How many times message has been re-queued?

Returns:

qNumRequeues

IQueueMessage qNumRequeues(int numRequeues)

Sets message's number of re-queue times.

Parameters:

numRequeues -

Returns:

qIncNumRequeues

IQueueMessage qIncNumRequeues()

Increases message's number of re-queue times by 1.

Returns:

qData

Object qData()

Data/content attached to the queue message.

Returns:

Since:

0.4.2

qData

IQueueMessage qData(Object data)

Attaches data/content to the queue message.

Parameters:

data -

Returns:

Since:

0.4.2