LibreOffice Module cppuhelper (master)  1
Classes | Public Member Functions | Private Attributes | List of all members
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:
[legend]

Classes

class  Impl
 

Public Member Functions

 UnoUrlDescriptor (rtl::OUString const &rDescriptor)
 Construct a descriptor from a string representation. More...
 
 UnoUrlDescriptor (UnoUrlDescriptor const &rOther)
 
 ~UnoUrlDescriptor ()
 
UnoUrlDescriptoroperator= (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

Implm_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 38 of file unourl.hxx.

Constructor & Destructor Documentation

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

Construct a descriptor from a string representation.

Parameters
rDescriptorThe string representation of a descriptor.
Exceptions
rtl::MalformedUriExceptionThrown when the given string representation is invalid.
UnoUrlDescriptor::UnoUrlDescriptor ( UnoUrlDescriptor const &  rOther)

Definition at line 131 of file unourl.cxx.

References clone(), and m_pImpl.

UnoUrlDescriptor::~UnoUrlDescriptor ( )

Definition at line 135 of file unourl.cxx.

References m_pImpl.

Member Function Documentation

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 151 of file unourl.cxx.

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

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 156 of file unourl.cxx.

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

OUString UnoUrlDescriptor::getParameter ( rtl::OUString const &  rKey) const

Return the parameter value for a key.

Parameters
rKeyA (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 167 of file unourl.cxx.

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

bool UnoUrlDescriptor::hasParameter ( rtl::OUString const &  rKey) const

Test whether the parameters contain a key.

Parameters
rKeyA (case insensitive) key.
Returns
True if the parameters contain a matching key/value pair.

Definition at line 161 of file unourl.cxx.

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

UnoUrlDescriptor & UnoUrlDescriptor::operator= ( UnoUrlDescriptor const &  rOther)

Definition at line 140 of file unourl.cxx.

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

Member Data Documentation

Impl* cppu::UnoUrlDescriptor::m_pImpl
private

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