org.apache.activemq.command

Class MessageId

java.lang.Object

org.apache.activemq.command.MessageId

All Implemented Interfaces:

java.lang.Comparable<MessageId>, DataStructure

public class MessageId
extends java.lang.Object
implements DataStructure, java.lang.Comparable<MessageId>

Field Summary

Fields

Modifier and Type	Field and Description
protected long	brokerSequenceId
static byte	DATA_STRUCTURE_TYPE
protected ProducerId	producerId
protected long	producerSequenceId
protected java.lang.String	textView

Constructor Summary

Constructors

Constructor and Description
MessageId()
MessageId(ProducerId producerId, long producerSequenceId)
MessageId(ProducerInfo producerInfo, long producerSequenceId)
MessageId(java.lang.String messageKey)
MessageId(java.lang.String producerId, long producerSequenceId)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MessageId other)
MessageId	copy()
boolean	equals(java.lang.Object o)
long	getBrokerSequenceId()
java.lang.Object	getDataLocator()
byte	getDataStructureType()
java.lang.Object	getEntryLocator()
java.lang.Object	getPlistLocator()
ProducerId	getProducerId()
long	getProducerSequenceId()
java.lang.String	getTextView()
int	hashCode()
boolean	isMarshallAware()
void	setBrokerSequenceId(long brokerSequenceId)
void	setDataLocator(java.lang.Object value) Sets a locator which aids a message store in loading a message faster.
void	setEntryLocator(java.lang.Object entryLocator)
void	setPlistLocator(java.lang.Object plistLocator)
void	setProducerId(ProducerId producerId)
void	setProducerSequenceId(long producerSequenceId)
void	setTextView(java.lang.String key) Sets the transient text view of the message which will be ignored if the message is marshaled on a transport; so is only for in-JVM changes to accommodate foreign JMS message IDs
void	setValue(java.lang.String messageKey) Sets the value as a String
java.lang.String	toProducerKey()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DATA_STRUCTURE_TYPE

public static final byte DATA_STRUCTURE_TYPE

See Also:

Constant Field Values

textView

protected java.lang.String textView

producerId

protected ProducerId producerId

producerSequenceId

protected long producerSequenceId

brokerSequenceId

protected long brokerSequenceId

Constructor Detail

MessageId

public MessageId()

MessageId

public MessageId(ProducerInfo producerInfo,
         long producerSequenceId)

MessageId

public MessageId(java.lang.String messageKey)

MessageId

public MessageId(java.lang.String producerId,
         long producerSequenceId)

MessageId

public MessageId(ProducerId producerId,
         long producerSequenceId)

Method Detail

setValue

public void setValue(java.lang.String messageKey)

Sets the value as a String

setTextView

public void setTextView(java.lang.String key)

Sets the transient text view of the message which will be ignored if the message is marshaled on a transport; so is only for in-JVM changes to accommodate foreign JMS message IDs

getTextView

public java.lang.String getTextView()

Returns:

getDataStructureType

public byte getDataStructureType()

Specified by:

getDataStructureType in interface DataStructure

Returns:

The type of the data structure

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toProducerKey

public java.lang.String toProducerKey()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getProducerId

public ProducerId getProducerId()

setProducerId

public void setProducerId(ProducerId producerId)

getProducerSequenceId

public long getProducerSequenceId()

setProducerSequenceId

public void setProducerSequenceId(long producerSequenceId)

getBrokerSequenceId

public long getBrokerSequenceId()

setBrokerSequenceId

public void setBrokerSequenceId(long brokerSequenceId)

isMarshallAware

public boolean isMarshallAware()

Specified by:

isMarshallAware in interface DataStructure

copy

public MessageId copy()

compareTo

public int compareTo(MessageId other)

Specified by:

compareTo in interface java.lang.Comparable<MessageId>

Parameters:

-

Returns:

See Also:

Comparable.compareTo(java.lang.Object)

getDataLocator

public java.lang.Object getDataLocator()

Returns:

a locator which aids a message store in loading a message faster. Only used by the message stores.

setDataLocator

public void setDataLocator(java.lang.Object value)

Sets a locator which aids a message store in loading a message faster. Only used by the message stores.

getEntryLocator

public java.lang.Object getEntryLocator()

setEntryLocator

public void setEntryLocator(java.lang.Object entryLocator)

getPlistLocator

public java.lang.Object getPlistLocator()

setPlistLocator

public void setPlistLocator(java.lang.Object plistLocator)