Library: Net
Package: Messages
Header: Poco/Net/NameValueCollection.h
A collection of name-value pairs that are used in various internet protocols like HTTP and SMTP.
The name is case-insensitive.
There can be more than one name-value pair with the same name.
Known Derived Classes: HTMLForm, HTTPRequest, HTTPMessage, HTTPResponse, HTTPServerRequest, HTTPServerRequestImpl, HTTPServerResponse, HTTPServerResponseImpl, MailMessage, MessageHeader
Member Functions: add, begin, clear, empty, end, erase, find, get, has, operator =, operator [], set, size, swap
typedef HeaderMap::const_iterator ConstIterator;
typedef std::multimap < std::string, std::string, ILT > HeaderMap;
typedef HeaderMap::iterator Iterator;
Creates an empty NameValueCollection.
NameValueCollection(
const NameValueCollection & nvc
);
Creates a NameValueCollection by copying another one.
virtual ~NameValueCollection();
Destroys the NameValueCollection.
void add(
const std::string & name,
const std::string & value
);
Adds a new name-value pair with the given name and value.
ConstIterator begin() const;
Returns an iterator pointing to the begin of the name-value pair collection.
void clear();
Removes all name-value pairs and their values.
bool empty() const;
Returns true if and only if the header does not have any content.
ConstIterator end() const;
Returns an iterator pointing to the end of the name-value pair collection.
void erase(
const std::string & name
);
Removes all name-value pairs with the given name.
ConstIterator find(
const std::string & name
) const;
Returns an iterator pointing to the first name-value pair with the given name.
const std::string & get(
const std::string & name
) const;
Returns the value of the first name-value pair with the given name.
Throws a NotFoundException if the name-value pair does not exist.
const std::string & get(
const std::string & name,
const std::string & defaultValue
) const;
Returns the value of the first name-value pair with the given name. If no value with the given name has been found, the defaultValue is returned.
bool has(
const std::string & name
) const;
Returns true if there is at least one name-value pair with the given name.
NameValueCollection & operator = (
const NameValueCollection & nvc
);
Assigns the name-value pairs of another NameValueCollection to this one.
const std::string & operator[] (
const std::string & name
) const;
Returns the value of the (first) name-value pair with the given name.
Throws a NotFoundException if the name-value pair does not exist.
void set(
const std::string & name,
const std::string & value
);
Sets the value of the (first) name-value pair with the given name.
int size() const;
Returns the number of name-value pairs in the collection.
void swap(
NameValueCollection & nvc
);
Swaps the NameValueCollection with another one.