cppu::UnoUrlDescriptor Class Reference

A descriptor as part of a UNO URL (connection descriptor or protocol descriptor). More...

#include <unourl.hxx>

Collaboration diagram for cppu::UnoUrlDescriptor:

Classes
class	Impl

Public Member Functions
	UnoUrlDescriptor (rtl::OUString const &rDescriptor)
	Construct a descriptor from a string representation. More...
	UnoUrlDescriptor (UnoUrlDescriptor const &rOther)
	~UnoUrlDescriptor ()
UnoUrlDescriptor &	operator= (UnoUrlDescriptor const &rOther)
rtl::OUString const &	getDescriptor () const
	Return the string representation of the descriptor. More...
rtl::OUString const &	getName () const
	Return the name component of the descriptor. More...
bool	hasParameter (rtl::OUString const &rKey) const
	Test whether the parameters contain a key. More...
rtl::OUString	getParameter (rtl::OUString const &rKey) const
	Return the parameter value for a key. More...

Private Attributes
Impl *	m_pImpl

Detailed Description

A descriptor as part of a UNO URL (connection descriptor or protocol descriptor).

Such a descriptor can also be useful outside the context of a full UNO URL. For example, some functions take a string representing a connection or protocol descriptor as input, and can use this class to parse the string.

Definition at line 45 of file unourl.hxx.

Constructor & Destructor Documentation

UnoUrlDescriptor() [1/2]

cppu::UnoUrlDescriptor::UnoUrlDescriptor ( rtl::OUString const &  rDescriptor )

explicit

Construct a descriptor from a string representation.

Parameters

rDescriptor

The string representation of a descriptor.

Exceptions

rtl::MalformedUriException

Thrown when the given string representation is invalid.

UnoUrlDescriptor() [2/2]

UnoUrlDescriptor::UnoUrlDescriptor

(

UnoUrlDescriptor const &

rOther

)

Definition at line 132 of file unourl.cxx.

References clone(), and m_pImpl.

~UnoUrlDescriptor()

UnoUrlDescriptor::~UnoUrlDescriptor

(

)

Definition at line 136 of file unourl.cxx.

References m_pImpl.

Member Function Documentation

getDescriptor()

OUString const & UnoUrlDescriptor::getDescriptor

(

)

const

Return the string representation of the descriptor.

Returns

A reference to the string representation used to construct this descriptor, without any modifications. The reference is valid for the lifetime of this URL object.

Definition at line 152 of file unourl.cxx.

References cppu::UnoUrlDescriptor::Impl::m_aDescriptor, and m_pImpl.

getName()

OUString const & UnoUrlDescriptor::getName

(

)

const

Return the name component of the descriptor.

Returns

A reference to the (case insensitive) name, in lower case form. The reference is valid for the lifetime of this URL object.

Definition at line 157 of file unourl.cxx.

References cppu::UnoUrlDescriptor::Impl::m_aName, and m_pImpl.

getParameter()

OUString UnoUrlDescriptor::getParameter

(

rtl::OUString const &

rKey

)

const

Return the parameter value for a key.

Parameters

rKey	A (case insensitive) key.

Returns

The (case sensitive) value associated with the given key, or an empty string if there is no matching key/value pair.

Definition at line 168 of file unourl.cxx.

References cppu::UnoUrlDescriptor::Impl::m_aParameters, and m_pImpl.

hasParameter()

bool UnoUrlDescriptor::hasParameter

(

rtl::OUString const &

rKey

)

const

Test whether the parameters contain a key.

Parameters

rKey	A (case insensitive) key.

Returns

True if the parameters contain a matching key/value pair.

Definition at line 162 of file unourl.cxx.

References cppu::UnoUrlDescriptor::Impl::m_aParameters, and m_pImpl.

operator=()

UnoUrlDescriptor & UnoUrlDescriptor::operator=

(

UnoUrlDescriptor const &

rOther

)

Definition at line 141 of file unourl.cxx.

References cppu::UnoUrlDescriptor::Impl::clone(), and m_pImpl.

Member Data Documentation

m_pImpl

Impl* cppu::UnoUrlDescriptor::m_pImpl

private

Definition at line 105 of file unourl.hxx.

Referenced by getDescriptor(), getName(), getParameter(), hasParameter(), operator=(), and ~UnoUrlDescriptor().

---

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

• unourl.hxx
• unourl.cxx