activemq::commands::BrokerId Class Reference

#include <src/main/activemq/commands/BrokerId.h>

Inheritance diagram for activemq::commands::BrokerId:

Public Types
typedef decaf::lang::PointerComparator < BrokerId >	COMPARATOR

Public Member Functions
	BrokerId ()
	BrokerId (const BrokerId &other)
virtual	~BrokerId ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual BrokerId *	cloneDataStructure () const
	Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
virtual void	copyDataStructure (const DataStructure *src)
	Copy the contents of the passed object into this objects members, overwriting any existing data.
virtual std::string	toString () const
	Returns a string containing the information for this DataStructure such as its type and value of its elements.
virtual bool	equals (const DataStructure *value) const
	Compares the DataStructure passed in to this one, and returns if they are equivalent.
virtual const std::string &	getValue () const
virtual std::string &	getValue ()
virtual void	setValue (const std::string &value)
virtual int	compareTo (const BrokerId &value) const
virtual bool	equals (const BrokerId &value) const
virtual bool	operator== (const BrokerId &value) const
virtual bool	operator< (const BrokerId &value) const
BrokerId &	operator= (const BrokerId &other)
Public Member Functions inherited from activemq::commands::BaseDataStructure
virtual	~BaseDataStructure ()
virtual bool	isMarshalAware () const
	Determine if the class implementing this interface is really wanting to be told about marshaling.
virtual void	beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	setMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED, const std::vector< char > &data AMQCPP_UNUSED)
virtual std::vector< unsigned char >	getMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
virtual void	copyDataStructure (const DataStructure *src AMQCPP_UNUSED)
virtual bool	equals (const DataStructure *value AMQCPP_UNUSED) const
Public Member Functions inherited from activemq::commands::DataStructure
virtual	~DataStructure ()
Public Member Functions inherited from activemq::wireformat::MarshalAware
virtual	~MarshalAware ()
virtual void	beforeMarshal (WireFormat *wireFormat)=0
	Called before marshaling is started to prepare the object to be marshaled.
virtual void	afterMarshal (WireFormat *wireFormat)=0
	Called after marshaling is started to cleanup the object being marshaled.
virtual void	beforeUnmarshal (WireFormat *wireFormat)=0
	Called before unmarshaling is started to prepare the object to be unmarshaled.
virtual void	afterUnmarshal (WireFormat *wireFormat)=0
	Called after unmarshaling is started to cleanup the object being unmarshaled.
virtual void	setMarshaledForm (WireFormat *wireFormat, const std::vector< char > &data)=0
	Called to set the data to this object that will contain the objects marshaled form.
virtual std::vector< unsigned char >	getMarshaledForm (WireFormat *wireFormat)=0
	Called to get the data to this object that will contain the objects marshaled form.
Public Member Functions inherited from decaf::lang::Comparable< BrokerId >
virtual	~Comparable ()
virtual int	compareTo (const BrokerId &value) const =0
	Compares this object with the specified object for order.
virtual bool	equals (const BrokerId &value) const =0
virtual bool	operator== (const BrokerId &value) const =0
	Compares equality between this object and the one passed.
virtual bool	operator< (const BrokerId &value) const =0
	Compares this object to another and returns true if this object is considered to be less than the one passed.

Static Public Attributes
static const unsigned char	ID_BROKERID = 124

Protected Attributes
std::string	value

Member Typedef Documentation

typedef decaf::lang::PointerComparator<BrokerId> activemq::commands::BrokerId::COMPARATOR

Constructor & Destructor Documentation

activemq::commands::BrokerId::BrokerId

(

)

activemq::commands::BrokerId::BrokerId

(

const BrokerId &

other

)

virtual activemq::commands::BrokerId::~BrokerId ( )

virtual

Member Function Documentation

virtual BrokerId* activemq::commands::BrokerId::cloneDataStructure ( ) const

virtual

Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.

Returns

new copy of this object.

Implements activemq::commands::DataStructure.

virtual int activemq::commands::BrokerId::compareTo ( const BrokerId &  value ) const

virtual

virtual void activemq::commands::BrokerId::copyDataStructure ( const DataStructure *  src )

virtual

Copy the contents of the passed object into this objects members, overwriting any existing data.

Returns

src - Source Object

Implements activemq::commands::DataStructure.

virtual bool activemq::commands::BrokerId::equals ( const DataStructure *  value ) const

virtual

Compares the DataStructure passed in to this one, and returns if they are equivalent.

Equivalent here means that they are of the same type, and that each element of the objects are the same.

Returns

true if DataStructure's are Equal.

Implements activemq::commands::DataStructure.

virtual bool activemq::commands::BrokerId::equals ( const BrokerId &  value ) const

virtual

virtual unsigned char activemq::commands::BrokerId::getDataStructureType ( ) const

virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns

The type of the data structure

Implements activemq::commands::DataStructure.

virtual const std::string& activemq::commands::BrokerId::getValue ( ) const

virtual

virtual std::string& activemq::commands::BrokerId::getValue ( )

virtual

virtual bool activemq::commands::BrokerId::operator< ( const BrokerId &  value ) const

virtual

BrokerId& activemq::commands::BrokerId::operator=

(

const BrokerId &

other

)

virtual bool activemq::commands::BrokerId::operator== ( const BrokerId &  value ) const

virtual

virtual void activemq::commands::BrokerId::setValue ( const std::string &  value )

virtual

virtual std::string activemq::commands::BrokerId::toString ( ) const

virtual

Returns a string containing the information for this DataStructure such as its type and value of its elements.

Returns

formatted string useful for debugging.

Reimplemented from activemq::commands::BaseDataStructure.

Field Documentation

const unsigned char activemq::commands::BrokerId::ID_BROKERID = 124

static

std::string activemq::commands::BrokerId::value

protected

---

The documentation for this class was generated from the following file:

• src/main/activemq/commands/BrokerId.h