activemq::commands::ActiveMQDestination Class Reference

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

Inheritance diagram for activemq::commands::ActiveMQDestination:

[legend]

Data Structures
struct	DestinationFilter
Public Types
typedef decaf::lang::PointerComparator < ActiveMQDestination >	COMPARATOR
Public Member Functions
	ActiveMQDestination ()
	ActiveMQDestination (const std::string &physicalName)
virtual	~ActiveMQDestination () throw ()
virtual ActiveMQDestination *	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)
virtual bool	equals (const DataStructure *value) const
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual std::string	toString () const
	Returns a string containing the information for this DataStructure such as its type and value of its elements.
int	getHashCode () const
virtual std::string	getPhysicalName () const
	Fetch this destination's physical name.
virtual void	setPhysicalName (const std::string &physicalName)
	Set this destination's physical name.
virtual bool	isAdvisory () const
virtual void	setAdvisory (bool advisory)
virtual bool	isExclusive () const
virtual void	setExclusive (bool exclusive)
virtual bool	isOrdered () const
virtual void	setOrdered (bool ordered)
virtual std::string	getOrderedTarget () const
virtual void	setOrderedTarget (const std::string &orderedTarget)
virtual cms::Destination::DestinationType	getDestinationType () const =0
	Returns the Type of Destination that this object represents.
std::string	getDestinationTypeAsString () const
	Returns the type of Destination that this object represents as a string, the available string values are, "Queue", "Topic", "TempQueue" and "TempTopic".
virtual bool	isTemporary () const
	Returns true if a temporary Destination.
virtual bool	isTopic () const
	Returns true if a Topic Destination.
virtual bool	isQueue () const
	Returns true if a Queue Destination.
virtual bool	isComposite () const
	Returns true if this destination represents a collection of destinations; allowing a set of destinations to be published to or subscribed from in one CMS operation.
decaf::util::ArrayList < Pointer< ActiveMQDestination > >	getCompositeDestinations () const
	Returns an ArrayList containing all the ActiveMQDestinations that comprise this Composite destination, if this destination is composite, otherwise it returns an empty list.
virtual bool	isWildcard () const
const activemq::util::ActiveMQProperties &	getOptions () const
virtual const cms::Destination *	getCMSDestination () const
Pointer< ActiveMQDestination >	createDestination (const std::string &name) const
	Create a new Destination that's of the same type as this one but with the given destination name.
virtual int	compareTo (const ActiveMQDestination &value) const
virtual bool	equals (const ActiveMQDestination &value) const
virtual bool	operator== (const ActiveMQDestination &value) const
virtual bool	operator< (const ActiveMQDestination &value) const
Static Public Member Functions
static std::string	createTemporaryName (const std::string &clientId)
	Create a temporary name from the clientId.
static std::string	getClientId (const ActiveMQDestination *destination)
	From a temporary destination find the clientId of the Connection that created it.
static Pointer < ActiveMQDestination >	createDestination (int type, const std::string &name)
	Creates a Destination given the String Name to use and a Type.
Static Public Attributes
static const unsigned char	ID_ACTIVEMQDESTINATION = 0
static const std::string	TEMP_DESTINATION_NAME_PREFIX
Protected Attributes
bool	exclusive
bool	ordered
bool	advisory
decaf::util::ArrayList < Pointer< ActiveMQDestination > >	compositeDestinations
std::string	orderedTarget
std::string	physicalName
util::ActiveMQProperties	options
int	hashCode
Static Protected Attributes
static const std::string	DEFAULT_ORDERED_TARGET
	The default target for ordered destinations.
static const std::string	TEMP_PREFIX
static const std::string	TEMP_POSTFIX
static const std::string	COMPOSITE_SEPARATOR
static const std::string	QUEUE_QUALIFIED_PREFIX
static const std::string	TOPIC_QUALIFIED_PREFIX
static const std::string	TEMP_QUEUE_QUALIFED_PREFIX
static const std::string	TEMP_TOPIC_QUALIFED_PREFIX

---

Member Typedef Documentation

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

---

Constructor & Destructor Documentation

activemq::commands::ActiveMQDestination::ActiveMQDestination

(

)

activemq::commands::ActiveMQDestination::ActiveMQDestination

(

const std::string &

physicalName

)

virtual activemq::commands::ActiveMQDestination::~ActiveMQDestination

(

)

throw () [virtual]

---

Member Function Documentation

virtual ActiveMQDestination* activemq::commands::ActiveMQDestination::cloneDataStructure

(

)

const [inline, 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.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

References NULL.

virtual int activemq::commands::ActiveMQDestination::compareTo

(

const ActiveMQDestination &

value

)

const [virtual]

virtual void activemq::commands::ActiveMQDestination::copyDataStructure

(

const DataStructure *

src

)

[virtual]

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

Referenced by activemq::commands::ActiveMQTempDestination::copyDataStructure().

static Pointer<ActiveMQDestination> activemq::commands::ActiveMQDestination::createDestination	(	int	type,
		const std::string &	name
	)			[static]

Creates a Destination given the String Name to use and a Type.

Parameters:

	type	- The Type of Destination to Create
	name	- The Name to use in the creation of the Destination

Returns:

Pointer to a new ActiveMQDestination instance.

Pointer<ActiveMQDestination> activemq::commands::ActiveMQDestination::createDestination

(

const std::string &

name

)

const [inline]

Create a new Destination that's of the same type as this one but with the given destination name.

Parameters:

name

The name

Returns:

Pointer to a new ActiveMQDestination.

static std::string activemq::commands::ActiveMQDestination::createTemporaryName

(

const std::string &

clientId

)

[inline, static]

Create a temporary name from the clientId.

Parameters:

clientId

Returns:

virtual bool activemq::commands::ActiveMQDestination::equals

(

const ActiveMQDestination &

value

)

const [virtual]

virtual bool activemq::commands::ActiveMQDestination::equals

(

const DataStructure *

value

)

const [virtual]

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

Referenced by activemq::commands::ActiveMQTempDestination::equals().

static std::string activemq::commands::ActiveMQDestination::getClientId

(

const ActiveMQDestination *

destination

)

[static]

From a temporary destination find the clientId of the Connection that created it.

Parameters:

destination

Returns:

the clientId or null if not a temporary destination

virtual const cms::Destination* activemq::commands::ActiveMQDestination::getCMSDestination

(

)

const [inline, virtual]

Returns:

the cms::Destination interface pointer that the objects that derive from this class implement.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

References NULL.

decaf::util::ArrayList< Pointer<ActiveMQDestination> > activemq::commands::ActiveMQDestination::getCompositeDestinations

(

)

const

Returns an ArrayList containing all the ActiveMQDestinations that comprise this Composite destination, if this destination is composite, otherwise it returns an empty list.

virtual unsigned char activemq::commands::ActiveMQDestination::getDataStructureType

(

)

const [virtual]

Get the DataStructure Type as defined in CommandTypes.h.

Returns:

The type of the data structure

Implements activemq::commands::DataStructure.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

virtual cms::Destination::DestinationType activemq::commands::ActiveMQDestination::getDestinationType

(

)

const [pure virtual]

Returns the Type of Destination that this object represents.

Returns:

int type qualifier.

Implemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

std::string activemq::commands::ActiveMQDestination::getDestinationTypeAsString

(

)

const

Returns the type of Destination that this object represents as a string, the available string values are, "Queue", "Topic", "TempQueue" and "TempTopic".

Returns:

The string value that represents the type of this destination.

int activemq::commands::ActiveMQDestination::getHashCode

(

)

const [inline]

const activemq::util::ActiveMQProperties& activemq::commands::ActiveMQDestination::getOptions

(

)

const [inline]

Returns:

a reference (const) to the options properties for this Destination.

virtual std::string activemq::commands::ActiveMQDestination::getOrderedTarget

(

)

const [inline, virtual]

Returns:

Returns the orderedTarget.

virtual std::string activemq::commands::ActiveMQDestination::getPhysicalName

(

)

const [inline, virtual]

Fetch this destination's physical name.

Returns:

const string containing the name

virtual bool activemq::commands::ActiveMQDestination::isAdvisory

(

)

const [inline, virtual]

Returns:

Returns the advisory.

virtual bool activemq::commands::ActiveMQDestination::isComposite

(

)

const [inline, virtual]

Returns true if this destination represents a collection of destinations; allowing a set of destinations to be published to or subscribed from in one CMS operation.

Returns:

true if this destination represents a collection of child destinations.

virtual bool activemq::commands::ActiveMQDestination::isExclusive

(

)

const [inline, virtual]

Returns:

Returns the exclusive.

virtual bool activemq::commands::ActiveMQDestination::isOrdered

(

)

const [inline, virtual]

Returns:

Returns the ordered.

virtual bool activemq::commands::ActiveMQDestination::isQueue

(

)

const [inline, virtual]

Returns true if a Queue Destination.

Returns:

true/false

virtual bool activemq::commands::ActiveMQDestination::isTemporary

(

)

const [inline, virtual]

Returns true if a temporary Destination.

Returns:

true/false

References cms::Destination::TEMPORARY_QUEUE, and cms::Destination::TEMPORARY_TOPIC.

virtual bool activemq::commands::ActiveMQDestination::isTopic

(

)

const [inline, virtual]

Returns true if a Topic Destination.

Returns:

true/false

References cms::Destination::TEMPORARY_TOPIC, and cms::Destination::TOPIC.

virtual bool activemq::commands::ActiveMQDestination::isWildcard

(

)

const [inline, virtual]

Returns:

true if the destination matches multiple possible destinations

virtual bool activemq::commands::ActiveMQDestination::operator<

(

const ActiveMQDestination &

value

)

const [virtual]

virtual bool activemq::commands::ActiveMQDestination::operator==

(

const ActiveMQDestination &

value

)

const [virtual]

virtual void activemq::commands::ActiveMQDestination::setAdvisory

(

bool

advisory

)

[inline, virtual]

Parameters:

advisory

The advisory to set.

virtual void activemq::commands::ActiveMQDestination::setExclusive

(

bool

exclusive

)

[inline, virtual]

Parameters:

exclusive

The exclusive to set.

virtual void activemq::commands::ActiveMQDestination::setOrdered

(

bool

ordered

)

[inline, virtual]

Parameters:

ordered

The ordered to set.

virtual void activemq::commands::ActiveMQDestination::setOrderedTarget

(

const std::string &

orderedTarget

)

[inline, virtual]

Parameters:

orderedTarget

The orderedTarget to set.

virtual void activemq::commands::ActiveMQDestination::setPhysicalName

(

const std::string &

physicalName

)

[virtual]

Set this destination's physical name.

Returns:

const string containing the name

Reimplemented in activemq::commands::ActiveMQTempDestination.

virtual std::string activemq::commands::ActiveMQDestination::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.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

---

Field Documentation

bool activemq::commands::ActiveMQDestination::advisory [protected]

const std::string activemq::commands::ActiveMQDestination::COMPOSITE_SEPARATOR [static, protected]

decaf::util::ArrayList< Pointer<ActiveMQDestination> > activemq::commands::ActiveMQDestination::compositeDestinations [mutable, protected]

const std::string activemq::commands::ActiveMQDestination::DEFAULT_ORDERED_TARGET [static, protected]

The default target for ordered destinations.

bool activemq::commands::ActiveMQDestination::exclusive [protected]

int activemq::commands::ActiveMQDestination::hashCode [protected]

const unsigned char activemq::commands::ActiveMQDestination::ID_ACTIVEMQDESTINATION = 0 [static]

util::ActiveMQProperties activemq::commands::ActiveMQDestination::options [protected]

bool activemq::commands::ActiveMQDestination::ordered [protected]

std::string activemq::commands::ActiveMQDestination::orderedTarget [protected]

std::string activemq::commands::ActiveMQDestination::physicalName [protected]

const std::string activemq::commands::ActiveMQDestination::QUEUE_QUALIFIED_PREFIX [static, protected]

const std::string activemq::commands::ActiveMQDestination::TEMP_DESTINATION_NAME_PREFIX [static]

const std::string activemq::commands::ActiveMQDestination::TEMP_POSTFIX [static, protected]

const std::string activemq::commands::ActiveMQDestination::TEMP_PREFIX [static, protected]

const std::string activemq::commands::ActiveMQDestination::TEMP_QUEUE_QUALIFED_PREFIX [static, protected]

const std::string activemq::commands::ActiveMQDestination::TEMP_TOPIC_QUALIFED_PREFIX [static, protected]

const std::string activemq::commands::ActiveMQDestination::TOPIC_QUALIFIED_PREFIX [static, protected]

---

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

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