org.apache.activemq.command
Class MessageId

java.lang.Object
  extended by org.apache.activemq.command.MessageId
All Implemented Interfaces:
Comparable<MessageId>, DataStructure

public class MessageId
extends Object
implements DataStructure, Comparable<MessageId>


Field Summary
protected  long brokerSequenceId
           
static byte DATA_STRUCTURE_TYPE
           
protected  ProducerId producerId
           
protected  long producerSequenceId
           
 
Constructor Summary
MessageId()
           
MessageId(ProducerId producerId, long producerSequenceId)
           
MessageId(ProducerInfo producerInfo, long producerSequenceId)
           
MessageId(String messageKey)
           
MessageId(String producerId, long producerSequenceId)
           
 
Method Summary
 int compareTo(MessageId other)
           
 MessageId copy()
           
 boolean equals(Object o)
           
 long getBrokerSequenceId()
           
 Object getDataLocator()
           
 byte getDataStructureType()
           
 Object getEntryLocator()
           
 Object getPlistLocator()
           
 ProducerId getProducerId()
           
 long getProducerSequenceId()
           
 int hashCode()
           
 boolean isMarshallAware()
           
 void setBrokerSequenceId(long brokerSequenceId)
           
 void setDataLocator(Object value)
          Sets a locator which aids a message store in loading a message faster.
 void setEntryLocator(Object entryLocator)
           
 void setPlistLocator(Object plistLocator)
           
 void setProducerId(ProducerId producerId)
           
 void setProducerSequenceId(long producerSequenceId)
           
 void setTextView(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(String messageKey)
          Sets the value as a String
 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

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(String messageKey)

MessageId

public MessageId(String producerId,
                 long producerSequenceId)

MessageId

public MessageId(ProducerId producerId,
                 long producerSequenceId)
Method Detail

setValue

public void setValue(String messageKey)
Sets the value as a String


setTextView

public void setTextView(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


getDataStructureType

public byte getDataStructureType()
Specified by:
getDataStructureType in interface DataStructure
Returns:
The type of the data structure

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class 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 Comparable<MessageId>
Parameters:
-
Returns:
See Also:
Comparable.compareTo(java.lang.Object)

getDataLocator

public 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(Object value)
Sets a locator which aids a message store in loading a message faster. Only used by the message stores.


getEntryLocator

public Object getEntryLocator()

setEntryLocator

public void setEntryLocator(Object entryLocator)

getPlistLocator

public Object getPlistLocator()

setPlistLocator

public void setPlistLocator(Object plistLocator)


Copyright © 2005-2013 The Apache Software Foundation. All Rights Reserved.