org.mule.runtime.core.message

Class GroupCorrelation

java.lang.Object

org.mule.runtime.core.message.GroupCorrelation

All Implemented Interfaces:

Serializable

public class GroupCorrelation
extends Object
implements Serializable

Immutable container for correlation properties relative to a Message.

Since:

4.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static GroupCorrelation	NO_CORRELATION
static String	NOT_SET

Constructor Summary

Constructors

Constructor and Description
GroupCorrelation(Integer groupSize, Integer sequence) Builds a new GroupCorrelation with the given parameters.

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	getGroupSize() Determines how many messages are in the correlation group
Optional<Integer>	getSequence() Gets the sequence or ordering number for this message in the the correlation group.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NOT_SET

public static final String NOT_SET

See Also:

Constant Field Values

NO_CORRELATION

public static final GroupCorrelation NO_CORRELATION

Constructor Detail

GroupCorrelation

public GroupCorrelation(Integer groupSize,
                        Integer sequence)

Builds a new GroupCorrelation with the given parameters.

Parameters:

groupSize - see getGroupSize().

sequence - see getSequence().

Method Detail

getSequence

public Optional<Integer> getSequence()

Gets the sequence or ordering number for this message in the the correlation group.

Returns:

the sequence number or null value if the sequence is not important

getGroupSize

public Optional<Integer> getGroupSize()

Determines how many messages are in the correlation group

Returns:

total messages in this group or null value if the size is not known

toString

public String toString()

Overrides:

toString in class Object