Implementation of the CMSProperties interface that delegates to a decaf::util::Properties object.
More...
#include <src/main/activemq/util/ActiveMQProperties.h>
Detailed Description
Implementation of the CMSProperties interface that delegates to a decaf::util::Properties object.
- Since
- 2.0
Constructor & Destructor Documentation
activemq::util::ActiveMQProperties::ActiveMQProperties |
( |
| ) |
|
virtual activemq::util::ActiveMQProperties::~ActiveMQProperties |
( |
| ) |
|
|
virtual |
Member Function Documentation
virtual void activemq::util::ActiveMQProperties::clear |
( |
| ) |
|
|
inlinevirtual |
virtual CMSProperties* activemq::util::ActiveMQProperties::clone |
( |
| ) |
const |
|
virtual |
virtual void activemq::util::ActiveMQProperties::copy |
( |
const CMSProperties * |
source | ) |
|
|
virtual |
virtual const char* activemq::util::ActiveMQProperties::getProperty |
( |
const std::string & |
name | ) |
const |
|
inlinevirtual |
Looks up the value for the given property.
- Parameters
-
name | The name of the property to be looked up. |
- Returns
- the value of the property with the given name, if it exists. If it does not exist, returns NULL.
Implements cms::CMSProperties.
virtual std::string activemq::util::ActiveMQProperties::getProperty |
( |
const std::string & |
name, |
|
|
const std::string & |
defaultValue |
|
) |
| const |
|
inlinevirtual |
Looks up the value for the given property.
- Parameters
-
name | the name of the property to be looked up. |
defaultValue | The value to be returned if the given property does not exist. |
- Returns
- The value of the property specified by
name
, if it exists, otherwise the defaultValue
.
Implements cms::CMSProperties.
virtual bool activemq::util::ActiveMQProperties::hasProperty |
( |
const std::string & |
name | ) |
const |
|
inlinevirtual |
Check to see if the Property exists in the set.
- Parameters
-
name | the name of the property to check |
- Returns
- true if property exists, false otherwise.
Implements cms::CMSProperties.
virtual bool activemq::util::ActiveMQProperties::isEmpty |
( |
| ) |
const |
|
inlinevirtual |
Returns true if the properties object is empty.
- Returns
- true if empty
Implements cms::CMSProperties.
virtual std::vector<std::string> activemq::util::ActiveMQProperties::propertyNames |
( |
| ) |
const |
|
inlinevirtual |
Returns a vector containing all the names of the properties currently stored in the Properties object.
- Returns
- an STL std::vector<std::string> with all the currently stored property names.
Implements cms::CMSProperties.
virtual std::string activemq::util::ActiveMQProperties::remove |
( |
const std::string & |
name | ) |
|
|
inlinevirtual |
Removes the property with the given name.
If the property existed in the collection then it is removed and returned, otherwise an empty string is returned.
- Parameters
-
name | the name of the property to be removed. |
- Returns
- the value that was removed from the Properties, or empty string.
Implements cms::CMSProperties.
virtual void activemq::util::ActiveMQProperties::setProperty |
( |
const std::string & |
name, |
|
|
const std::string & |
value |
|
) |
| |
|
inlinevirtual |
Sets the value for a given property.
If the property already exists, overwrites the value.
- Parameters
-
name | The name of the value to be written. |
value | The value to be written. |
Implements cms::CMSProperties.
virtual int activemq::util::ActiveMQProperties::size |
( |
| ) |
const |
|
inlinevirtual |
Returns the current count of all the Properties that are currently stored in the Properties object.
- Returns
- the number of properties currently stored.
Implements cms::CMSProperties.
virtual std::vector<std::pair<std::string, std::string> > activemq::util::ActiveMQProperties::toArray |
( |
| ) |
const |
|
inlinevirtual |
Method that serializes the contents of the property map to an array.
- Returns
- list of pairs where the first is the name and the second is the value.
Implements cms::CMSProperties.
virtual std::string activemq::util::ActiveMQProperties::toString |
( |
| ) |
const |
|
inlinevirtual |
Formats the contents of the Properties Object into a string that can be logged, etc.
- Returns
- string value of this object.
Implements cms::CMSProperties.
The documentation for this class was generated from the following file: