com.solacesystems.solclientj.core.handle

Interface ReplicationGroupMessageIdHandle

All Superinterfaces:

Handle

public interface ReplicationGroupMessageIdHandle
extends Handle

The ReplicationGroupMessageIdHandle interface allows applications to serialize a ReplicationGroupMessageId object into a ReplicationGroupMessageId formatted String, compare ReplicationGroupMessageId objects and validate ReplicationGroupMessageId objects in the Native API.

Applications that need this interface must instantiate an object with the ReplicationGroupMessageIdHandle interface by calling Allocator.newReplicationGroupMessageIdHandle(). To deserialize ReplicationGroupMessageId formatted String into an allocated ReplicationGroupMessageIdHandle object, applications must call Solclient.createReplicationGroupMessageIdForHandle()

The ReplicationGroupMessageIdHandle can also be received from the ReplicationGroupMessageId in the message by calling getReplicationGroupMessageIdForHandle(ReplicationGroupMessageIdHandle)

Method Summary

Modifier and Type	Method and Description
int	compare(ReplicationGroupMessageIdHandle otherReplicationGroupMessageIdHandle) Compares this instance of the ReplicationGroupMessageIdHandle object with the passed in other ReplicationGroupMessageIdHandle object.
boolean	isValid() Validates if the ReplicationGroupMessageIdHandle object is valid.
java.lang.String	toString() Serializes the ReplicationGroupMessageIdHandle object into a ReplicationGroupMessageId formatted String.

Methods inherited from interface com.solacesystems.solclientj.core.handle.Handle

destroy, isBound

Method Detail

toString

java.lang.String toString()

Serializes the ReplicationGroupMessageIdHandle object into a ReplicationGroupMessageId formatted String. If the String fails to be serialized, the method will return null.

Overrides:

toString in class java.lang.Object

Returns:

ReplicationGroupMessageId formatted String

compare

int compare(ReplicationGroupMessageIdHandle otherReplicationGroupMessageIdHandle)
     throws SolclientException

Compares this instance of the ReplicationGroupMessageIdHandle object with the passed in other ReplicationGroupMessageIdHandle object. If the other ReplicationGroupMessageIdHandle object is not a 'bound' handle or the incorrect type, the method throws an IllegalArgumentException.

Parameters:

otherReplicationGroupMessageIdHandle -

Returns:

int 0 - if both ReplicationGroupMessageIdHandle objects are equivalent. -1 - if this instance of the ReplicationGroupMessageIdHandle object is less than the other ReplicationGroupMessageIdHandle object. 1 - if this instance of the ReplicationGroupMessageIdHandle object is more than the other ReplicationGroupMessageIdHandle object.

Throws:

SolclientException - If the compare fails.

isValid

boolean isValid()

Validates if the ReplicationGroupMessageIdHandle object is valid.

Returns:

boolean - true if valid, else false.