org.mule.runtime.api.message

Class ItemSequenceInfo

java.lang.Object

org.mule.runtime.api.message.ItemSequenceInfo

All Implemented Interfaces:

Serializable

public final class ItemSequenceInfo
extends Object
implements Serializable

Immutable container for an Event sequence information.

Since:

1.1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOT_SET

Method Summary

Modifier and Type	Method and Description
int	getPosition() Gets the position or ordering number for this event in the the sequence, starting from 0 up to getSequenceSize() - 1 in case it's defined
OptionalInt	getSequenceSize() Determines how many events are in the sequence
static ItemSequenceInfo	of(int position)
static ItemSequenceInfo	of(int position, int sequenceSize)
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

Method Detail

of

public static ItemSequenceInfo of(int position)

of

public static ItemSequenceInfo of(int position,
                                  int sequenceSize)

getPosition

public int getPosition()

Gets the position or ordering number for this event in the the sequence, starting from 0 up to getSequenceSize() - 1 in case it's defined

Returns:

the position of the item inside the sequence.

getSequenceSize

public OptionalInt getSequenceSize()

Determines how many events are in the sequence

Returns:

total events in this sequence or OptionalInt.empty() value if the size is not known

toString

public String toString()

Overrides:

toString in class Object