com.solacesystems.jcsmp

Interface ReplicationGroupMessageId

All Superinterfaces:

ReplayStartLocation

@ProviderType
public interface ReplicationGroupMessageId
extends ReplayStartLocation

ReplicationGroupMessageId specifies a Replication Group Message ID as a replay start location. ReplicationGroupMessageId is the interface applications may use to access a ReplicationGroupMessageId which cannot be instantiated. This interface is not implementable on applications' objects. A ReplicationGroupMessageId can only be created by JCSMPFactory.createReplicationGroupMessageId method, or retrieved from an XMLMessage.getReplicationGroupMessageId method.

Use this object's toString method to obtain a string that can be subsequently passed to the JCSMPFactory.createReplicationGroupMessageId method.

Method Summary

Modifier and Type	Method and Description
int	compare(ReplicationGroupMessageId id) Compare with the other ReplicationGroupMessageId
String	toString() Get ReplicationGroupMessageId in string format

Method Detail

compare

int compare(ReplicationGroupMessageId id)
     throws JCSMPNotComparableException

Compare with the other ReplicationGroupMessageId

Parameters:

id - The other ReplicationGroupMessageId

Returns:

0 if the ReplicationGroupMessageId is equal to the other ReplicationGroupMessageId. < 0 if the ReplicationGroupMessageId is less than the other ReplicationGroupMessageId. > 0 if the ReplicationGroupMessageId is greater than the other ReplicationGroupMessageId.

Throws:

JCSMPNotComparableException - if the two ReplicationGroupMessageId are not comparable. ReplicationGroupMessageId cannot be compared because the messages identified were not published to the same broker or HA pair. NullPointerException when id is null

toString

String toString()

Get ReplicationGroupMessageId in string format

Overrides:

toString in class Object

Returns:

ReplicationGroupMessageId in string format