OpFlex Framework  1.3.0
opflex::modb::URIBuilder Class Reference

Build a URI using path elements from the root of the tree. More...

#include <opflex/modb/URIBuilder.h>

Public Member Functions

 URIBuilder ()
 Construct an empty URI builder representing the root element.
 
 URIBuilder (const URI &uri)
 Construct a URI builder that will append URI elements to the specified URI. More...
 
 ~URIBuilder ()
 Destroy the URI Builder.
 
URIBuilderaddElement (const std::string &elementValue)
 Add a string-valued path element to the URI path, and URI-escape the value. More...
 
URIBuilderaddElement (uint32_t elementValue)
 Add an unsigned int-valued path element to the URI path. More...
 
URIBuilderaddElement (int32_t elementValue)
 Add a signed int-valued path element to the URI path. More...
 
URIBuilderaddElement (uint64_t elementValue)
 Add an unsigned int-valued path element to the URI path. More...
 
URIBuilderaddElement (int64_t elementValue)
 Add a signed int-valued path element to the URI path. More...
 
URIBuilderaddElement (const MAC &elementValue)
 Add a mac-address-valued path element to the URI path. More...
 
URIBuilderaddElement (const URI &elementValue)
 Add a URI path element to the URI path. More...
 
URI build ()
 Build the URI from the path elements and return it.
 

Friends

class URIBuilderImpl
 

Detailed Description

Build a URI using path elements from the root of the tree.

Constructor & Destructor Documentation

opflex::modb::URIBuilder::URIBuilder ( const URI uri)

Construct a URI builder that will append URI elements to the specified URI.

Parameters
urithe URI to build from

Member Function Documentation

URIBuilder& opflex::modb::URIBuilder::addElement ( const std::string &  elementValue)

Add a string-valued path element to the URI path, and URI-escape the value.

Parameters
elementValuethe value of the element
URIBuilder& opflex::modb::URIBuilder::addElement ( uint32_t  elementValue)

Add an unsigned int-valued path element to the URI path.

Parameters
elementValuethe value of the element
URIBuilder& opflex::modb::URIBuilder::addElement ( int32_t  elementValue)

Add a signed int-valued path element to the URI path.

Parameters
elementValuethe value of the element
URIBuilder& opflex::modb::URIBuilder::addElement ( uint64_t  elementValue)

Add an unsigned int-valued path element to the URI path.

Parameters
elementValuethe value of the element
URIBuilder& opflex::modb::URIBuilder::addElement ( int64_t  elementValue)

Add a signed int-valued path element to the URI path.

Parameters
elementValuethe value of the element
URIBuilder& opflex::modb::URIBuilder::addElement ( const MAC elementValue)

Add a mac-address-valued path element to the URI path.

Parameters
elementValuethe value of the element
URIBuilder& opflex::modb::URIBuilder::addElement ( const URI elementValue)

Add a URI path element to the URI path.

Note that this does not append the URI; this is actually a path element whose value is the URI.

Parameters
elementValuethe value of the element

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