represents generic, mutable URI references. More...

import"XUriReference.idl";

Inheritance diagram for XUriReference:

Public Member Functions
string	getUriReference ()
	returns the textual representation of the complete URI reference. More...

boolean	isAbsolute ()
	returns whether this URI reference is absolute or relative. More...

string	getScheme ()
	returns the scheme part of this (absolute) URI reference. More...

string	getSchemeSpecificPart ()
	returns the scheme-specific part of this URI reference. More...

boolean	isHierarchical ()
	returns whether this URI reference is hierarchical or opaque, in the sense of RFC&nbsp2396. More...

boolean	hasAuthority ()
	returns whether this URI reference has an authority part. More...

string	getAuthority ()
	returns the authority part of this URI reference. More...

string	getPath ()
	returns the path part of this URI reference. More...

boolean	hasRelativePath ()
	returns whether this URI reference has a relative path. More...

long	getPathSegmentCount ()
	returns the number of path segments of this URI reference. More...

string	getPathSegment ([in] long index)
	returns a given path segment of this URI reference. More...

boolean	hasQuery ()
	returns whether this URI reference has a query part. More...

string	getQuery ()
	returns the query part of this URI reference. More...

boolean	hasFragment ()
	returns whether this URI reference has a fragment part. More...

string	getFragment ()
	returns the fragment part of this URI reference. More...

void	setFragment ([in] string fragment)
	sets the fragment part of this URI reference. More...

void	clearFragment ()
	clears the fragment part of this URI reference. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Detailed Description

represents generic, mutable URI references.

See RFC 3986 for a description of URI references and related terms.

This interface only handles generic URI references (both absolute and relative). For specific URI schemes, there will be additional interfaces that offer extra, scheme-specific functionality.

See also: com::sun::star::uri::UriReferenceFactory which allows to create URI reference objects that support com::sun::star::uri::XUriReference and additional, scheme-specific interfaces.

Since: OOo 2.0

Member Function Documentation

◆ clearFragment()

void clearFragment ( )

clears the fragment part of this URI reference.

◆ getAuthority()

string getAuthority ( )

returns the authority part of this URI reference.

Returns: the textual representation of the authority part (with the exact spelling retained), if this is a URI reference that has an authority part; otherwise, an empty string is returned.

◆ getFragment()

string getFragment ( )

returns the fragment part of this URI reference.

Returns: the textual representation of the fragment part (with the exact spelling retained; without the delimiting “#”), if this is a URI reference that has a fragment part; otherwise, an empty string is returned.

◆ getPath()

string getPath ( )

returns the path part of this URI reference.

Returns: the textual representation of the path part (with the exact spelling retained).

◆ getPathSegment()

string getPathSegment ( [in] long index )

returns a given path segment of this URI reference.

Parameters

index the index of the path segment, starting at zero.

Returns: the textual representation of the given path segment (with the exact spelling retained, without any delimiting “/”), if this URI reference has that many path segments; otherwise, and in particular if index is negative, an empty string is returned.

◆ getPathSegmentCount()

long getPathSegmentCount ( )

returns the number of path segments of this URI reference.

For a URI reference with an empty path, the number of path segments is zero. For a URI reference with an absolute, non-empty path, the number of path segments equals the number of “/” delimiters. For a URI reference with a relative, non-empty path, the number of path segments equals the number of “/” delimiters, plus one.

Returns: the number of path segments.

◆ getQuery()

string getQuery ( )

returns the query part of this URI reference.

Returns: the textual representation of the query part (with the exact spelling retained; without the delimiting “?”), if this is a URI reference that has a query part; otherwise, an empty string is returned.

◆ getScheme()

string getScheme ( )

returns the scheme part of this (absolute) URI reference.

Returns: the textual representation of the scheme part (with the exact spelling retained; without the delimiting “:”), if this is an absolute URI reference; otherwise, an empty string is returned.

◆ getSchemeSpecificPart()

string getSchemeSpecificPart ( )

returns the scheme-specific part of this URI reference.

For an absolute URI reference, the scheme-specific part is everything after the scheme part and the delimiting “:”, and before the optional “#” and fragment part. For a relative URI reference, the scheme-specific part is everything before the optional “#” and fragment part.

Returns: the textual representation of the scheme-specific part (with the exact spelling retained).

◆ getUriReference()

string getUriReference ( )

returns the textual representation of the complete URI reference.

Returns: the textual representation of the complete URI reference. The exact spelling of the URI reference is retained.

◆ hasAuthority()

boolean hasAuthority ( )

returns whether this URI reference has an authority part.

Returns: TRUE if this URI reference has an authority part.

◆ hasFragment()

boolean hasFragment ( )

returns whether this URI reference has a fragment part.

Returns: TRUE if this URI reference has a fragment part.

◆ hasQuery()

boolean hasQuery ( )

returns whether this URI reference has a query part.

Returns: TRUE if this URI reference has a query part.

◆ hasRelativePath()

boolean hasRelativePath ( )

returns whether this URI reference has a relative path.

Returns: TRUE if this URI reference has a relative path.

◆ isAbsolute()

boolean isAbsolute ( )

returns whether this URI reference is absolute or relative.

A URI is absolute if it has a scheme.

Returns: TRUE if this URI reference is absolute, FALSE if it is relative.

◆ isHierarchical()

boolean isHierarchical ( )

returns whether this URI reference is hierarchical or opaque, in the sense of RFC&nbsp2396.

An absolute URI reference is hierarchical if its scheme-specific part starts with “/”. A relative URI reference is always hierarchical.

Returns: TRUE if this URI reference is hierarchical, FALSE if it is opaque.

Deprecated:: RFC 3986 no longer differentiates between hierarchical and opaque URIs.

◆ setFragment()

void setFragment ( [in] string fragment )

sets the fragment part of this URI reference.