IQueueMessage (ddth-queue-core 1.0.0 API)

All Superinterfaces:

Cloneable, IMessage<ID,DATA>

All Known Implementing Classes:

BaseUniversalQueueMessage, GenericQueueMessage, IQueueMessage.EmptyQueueMessage, UniversalIdIntQueueMessage, UniversalIdStrQueueMessage
```
public interface IQueueMessage<ID,DATA>
extends IMessage<ID,DATA>
```
Represents a queue message.

Since:

0.1.0

Author:

Thanh Ba Nguyen

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class IQueueMessage.EmptyQueueMessage
An empty queue message.
- Nested classes/interfaces inherited from interface com.github.ddth.queue.IMessage
  IMessage.EmptyMessage

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IQueueMessage<ID,DATA>`	`clone()`	Clone this message.
`int`	`getNumRequeues()`	How many times message has been re-queued?
`Date`	`getQueueTimestamp()`	Get message's last-queued timestamp.
`IQueueMessage<ID,DATA>`	`incNumRequeues()`	Increase message's number of re-queue times by 1.
`IQueueMessage<ID,DATA>`	`setNumRequeues(int numRequeues)`	Set message's number of re-queue times.
`IQueueMessage<ID,DATA>`	`setQueueTimestamp(Date timestamp)`	Set message's last-queued timestamp.

Methods inherited from interface com.github.ddth.queue.IMessage
getData, getId, getTimestamp, setData, setId, setTimestamp

- Method Detail
  - clone
```
IQueueMessage<ID,DATA> clone()
```
    Clone this message.
    
    Specified by:
    
    clone in interface IMessage<ID,DATA>
    
    Returns:
    
    Since:
    
    0.4.0
  - getQueueTimestamp
```
Date getQueueTimestamp()
```
    Get message's last-queued timestamp.
    
    Returns:
    
    Since:
    
    0.7.0
  - setQueueTimestamp
```
IQueueMessage<ID,DATA> setQueueTimestamp(Date timestamp)
```
    Set message's last-queued timestamp.
    
    Parameters:
    
    timestamp -
    
    Returns:
    
    Since:
    
    0.7.0
  - getNumRequeues
```
int getNumRequeues()
```
    How many times message has been re-queued?
    
    Returns:
    
    Since:
    
    0.7.0
  - setNumRequeues
```
IQueueMessage<ID,DATA> setNumRequeues(int numRequeues)
```
    Set message's number of re-queue times.
    
    Parameters:
    
    numRequeues -
    
    Returns:
    
    Since:
    
    0.7.0
  - incNumRequeues
```
IQueueMessage<ID,DATA> incNumRequeues()
```
    Increase message's number of re-queue times by 1.
    
    Returns:
    
    Since:
    
    0.7.0