MessageGroup (Spring Integration 5.4.0 API)

All Known Implementing Classes:

AbstractCorrelatingMessageHandler.SequenceAwareMessageGroup, SimpleMessageGroup
```
public interface MessageGroup
```
A group of messages that are correlated with each other and should be processed in the same context.
The message group allows implementations to be mutable, but this behavior is optional. Implementations should take care to document their thread safety and mutability.

Author:

Dave Syer, Oleg Zhurakousky, Gary Russell, Artem Bilan

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(Message<?> messageToAdd)` Add the message to this group.
`boolean`	`canAdd(Message<?> message)` Query if the message can be added.
`void`	`clear()`
`void`	`complete()` Complete the group.
`Object`	`getGroupId()`
`long`	`getLastModified()`
`int`	`getLastReleasedMessageSequenceNumber()`
`Collection<Message<?>>`	`getMessages()` Returns all available Messages from the group at the time of invocation
`Message<?>`	`getOne()`
`int`	`getSequenceSize()`
`long`	`getTimestamp()`
`boolean`	`isComplete()`
`boolean`	`remove(Message<?> messageToRemove)` Remove the message from this group.
`void`	`setLastModified(long lastModified)`
`void`	`setLastReleasedMessageSequenceNumber(int sequenceNumber)`
`int`	`size()`

- Method Detail
  - canAdd
```
boolean canAdd(Message<?> message)
```
    Query if the message can be added.
    
    Parameters:
    
    message - The message.
    
    Returns:
    
    true if the message can be added.
  - add
```
void add(Message<?> messageToAdd)
```
    Add the message to this group.
    
    Parameters:
    
    messageToAdd - the message to add.
    
    Since:
    
    4.3
  - remove
```
boolean remove(Message<?> messageToRemove)
```
    Remove the message from this group.
    
    Parameters:
    
    messageToRemove - the message to remove.
    
    Returns:
    
    true if a message was removed.
    
    Since:
    
    4.3
  - getMessages
```
Collection<Message<?>> getMessages()
```
    Returns all available Messages from the group at the time of invocation
    
    Returns:
    
    The messages.
  - getGroupId
```
Object getGroupId()
```
    Returns:
    
    the key that links these messages together
  - getLastReleasedMessageSequenceNumber
```
int getLastReleasedMessageSequenceNumber()
```
    Returns:
    
    the sequenceNumber of the last released message. Used in Resequencer use cases only
  - setLastReleasedMessageSequenceNumber
```
void setLastReleasedMessageSequenceNumber(int sequenceNumber)
```
  - isComplete
```
boolean isComplete()
```
    Returns:
    
    true if the group is complete (i.e. no more messages are expected to be added)
  - complete
```
void complete()
```
    Complete the group.
  - getSequenceSize
```
int getSequenceSize()
```
    Returns:
    
    the size of the sequence expected 0 if unknown
  - size
```
int size()
```
    Returns:
    
    the total number of messages in this group
  - getOne
```
Message<?> getOne()
```
    Returns:
    
    a single message from the group
  - getTimestamp
```
long getTimestamp()
```
    Returns:
    
    the timestamp (milliseconds since epoch) associated with the creation of this group
  - getLastModified
```
long getLastModified()
```
    Returns:
    
    the timestamp (milliseconds since epoch) associated with the time this group was last updated
  - setLastModified
```
void setLastModified(long lastModified)
```
  - clear
```
void clear()
```

Interface MessageGroup

Method Summary

Method Detail

canAdd

add

remove

getMessages

getGroupId

getLastReleasedMessageSequenceNumber

setLastReleasedMessageSequenceNumber

isComplete

complete

getSequenceSize

size

getOne

getTimestamp

getLastModified

setLastModified

clear