decaf::internal::net::URIType Class Reference

Basic type object that holds data that composes a given URI. More...

#include <src/main/decaf/internal/net/URIType.h>

Public Member Functions

 URIType (const std::string &source)
 URIType ()
virtual ~URIType ()
std::string getSource () const
 Gets the source URI string that was parsed to obtain this URIType instance and the resulting data,.
void setSource (const std::string &source)
 Sets the source URI string that was parsed to obtain this URIType instance and the resulting data,.
std::string getScheme () const
 Gets the Scheme of the URI, e.g.
void setScheme (const std::string &scheme)
 Sets the Scheme of the URI, e.g.
std::string getSchemeSpecificPart () const
 Gets the Scheme Specific Part of the URI.
void setSchemeSpecificPart (const std::string &schemeSpecificPart)
 Sets the Scheme Specific Part of the URI.
std::string getAuthority () const
 Gets the Authority of the URI.
void setAuthority (const std::string &authority)
 Sets the Authority of the URI.
std::string getUserInfo () const
 Gets the user info part of the URI, e.g.
void setUserInfo (const std::string &userinfo)
 Sets the user info part of the URI, e.g.
std::string getHost () const
 Gets the Host name part of the URI.
void setHost (const std::string &host)
 Sets the Host name part of the URI.
int getPort () const
 Gets the port part of the URI.
void setPort (int port)
 Sets the port part of the URI.
std::string getPath () const
 Gets the Path part of the URI.
void setPath (const std::string &path)
 Sets the Path part of the URI.
std::string getQuery () const
 Gets the Query part of the URI.
void setQuery (const std::string &query)
 Sets the Query part of the URI.
std::string getFragment () const
 Gets the Fragment part of the URI.
void setFragment (const std::string &fragment)
 Sets the Fragment part of the URI.
bool isOpaque () const
 Gets if the URI is Opaque.
void setOpaque (bool opaque)
 Sets if the URI is Opaque.
bool isAbsolute () const
 Gets if the URI is Absolute.
void setAbsolute (bool absolute)
 Sets if the URI is Absolute.
bool isServerAuthority () const
 Gets if the URI is a Server Authority.
void setServerAuthority (bool serverAuthority)
 Sets if the URI is a Server Authority.
bool isValid () const
 Gets if the URI is valid, meaning that the source has been set and parsed and all relevant data fields have been set.
void setValid (bool valid)
 Sets if the URI is valid, meaning that the source has been set and parsed and all relevant data fields have been set.

Detailed Description

Basic type object that holds data that composes a given URI.


Constructor & Destructor Documentation

decaf::internal::net::URIType::URIType ( const std::string &  source  )  [inline]
decaf::internal::net::URIType::URIType (  )  [inline]
virtual decaf::internal::net::URIType::~URIType (  )  [inline, virtual]

Member Function Documentation

std::string decaf::internal::net::URIType::getAuthority (  )  const [inline]

Gets the Authority of the URI.

Returns:
Authority part string.
std::string decaf::internal::net::URIType::getFragment (  )  const [inline]

Gets the Fragment part of the URI.

Returns:
Fragment part string.
std::string decaf::internal::net::URIType::getHost (  )  const [inline]

Gets the Host name part of the URI.

Returns:
Host name part string.
std::string decaf::internal::net::URIType::getPath (  )  const [inline]

Gets the Path part of the URI.

Returns:
Path part string.
int decaf::internal::net::URIType::getPort (  )  const [inline]

Gets the port part of the URI.

Returns:
port part string, -1 if not set.
std::string decaf::internal::net::URIType::getQuery (  )  const [inline]

Gets the Query part of the URI.

Returns:
Query part string.
std::string decaf::internal::net::URIType::getScheme (  )  const [inline]

Gets the Scheme of the URI, e.g.

scheme ("http"/"ftp"/...).

Returns:
scheme part string.
std::string decaf::internal::net::URIType::getSchemeSpecificPart (  )  const [inline]

Gets the Scheme Specific Part of the URI.

Returns:
scheme specific part string.
std::string decaf::internal::net::URIType::getSource (  )  const [inline]

Gets the source URI string that was parsed to obtain this URIType instance and the resulting data,.

Returns:
the source URI string
std::string decaf::internal::net::URIType::getUserInfo (  )  const [inline]

Gets the user info part of the URI, e.g.

user name, as in http://user:passwd@host:port/

Returns:
user info part string.
bool decaf::internal::net::URIType::isAbsolute (  )  const [inline]

Gets if the URI is Absolute.

Returns:
true if Absolute.
bool decaf::internal::net::URIType::isOpaque (  )  const [inline]

Gets if the URI is Opaque.

Returns:
true if opaque.
bool decaf::internal::net::URIType::isServerAuthority (  )  const [inline]

Gets if the URI is a Server Authority.

Returns:
true if Server Authority.
bool decaf::internal::net::URIType::isValid (  )  const [inline]

Gets if the URI is valid, meaning that the source has been set and parsed and all relevant data fields have been set.

Returns:
true if the URIType contains valid data.
void decaf::internal::net::URIType::setAbsolute ( bool  absolute  )  [inline]

Sets if the URI is Absolute.

Parameters:
absolute - true if Absolute.
void decaf::internal::net::URIType::setAuthority ( const std::string &  authority  )  [inline]

Sets the Authority of the URI.

Parameters:
authority Authority part string.
void decaf::internal::net::URIType::setFragment ( const std::string &  fragment  )  [inline]

Sets the Fragment part of the URI.

Parameters:
fragment - Fragment part string.
void decaf::internal::net::URIType::setHost ( const std::string &  host  )  [inline]

Sets the Host name part of the URI.

Parameters:
host - Host name part string.
void decaf::internal::net::URIType::setOpaque ( bool  opaque  )  [inline]

Sets if the URI is Opaque.

Parameters:
opaque true if opaque.
void decaf::internal::net::URIType::setPath ( const std::string &  path  )  [inline]

Sets the Path part of the URI.

Parameters:
path - Path part string.
void decaf::internal::net::URIType::setPort ( int  port  )  [inline]

Sets the port part of the URI.

Parameters:
port - port part string, -1 if not set.
void decaf::internal::net::URIType::setQuery ( const std::string &  query  )  [inline]

Sets the Query part of the URI.

Parameters:
query - Query part string.
void decaf::internal::net::URIType::setScheme ( const std::string &  scheme  )  [inline]

Sets the Scheme of the URI, e.g.

scheme ("http"/"ftp"/...).

Parameters:
scheme - scheme part string.
void decaf::internal::net::URIType::setSchemeSpecificPart ( const std::string &  schemeSpecificPart  )  [inline]

Sets the Scheme Specific Part of the URI.

Parameters:
schemeSpecificPart - scheme specific part string.
void decaf::internal::net::URIType::setServerAuthority ( bool  serverAuthority  )  [inline]

Sets if the URI is a Server Authority.

Parameters:
serverAuthority - true if Server Authority.
void decaf::internal::net::URIType::setSource ( const std::string &  source  )  [inline]

Sets the source URI string that was parsed to obtain this URIType instance and the resulting data,.

Parameters:
source - the source URI string
void decaf::internal::net::URIType::setUserInfo ( const std::string &  userinfo  )  [inline]

Sets the user info part of the URI, e.g.

user name, as in http://user:passwd@host:port/

Parameters:
userinfo - user info part string.
void decaf::internal::net::URIType::setValid ( bool  valid  )  [inline]

Sets if the URI is valid, meaning that the source has been set and parsed and all relevant data fields have been set.

Parameters:
valid - true if the URIType contains valid data.

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

Generated on 1 Dec 2014 for activemq-cpp-3.8.2 by  doxygen 1.6.1