1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_uri_XUriSchemeParser_idl__
29#define __com_sun_star_uri_XUriSchemeParser_idl__
30
31#include <com/sun/star/uno/XInterface.idl>
32#include <com/sun/star/uri/XUriReference.idl>
33
34module com { module sun { module star { module uri {
35
36/**
37   parses textual representations of absolute URIs.
38
39   <p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a> for a
40   description of URIs and related terms.</p>
41
42   @since OOo 2.0
43 */
44published interface XUriSchemeParser: com::sun::star::uno::XInterface {
45    /**
46       parses the textual representation of an absolute URI.
47
48       <p>This method is used to parse URIs (with no fragment part), not URI
49       references (with an optional fragment part).</p>
50
51       <p>If an object is returned, the behaviour of its
52       <type scope="com::sun::star::uri">XUriReference</type> methods must
53       reflect the fact that the object represents an absolute URI reference
54       with the given scheme and scheme-specific part, and without a fragment
55       part.</p>
56
57       @param scheme
58       the textual representation of the scheme part (without the delimiting
59       &ldquo;<code>:</code>&rdquo;).
60
61       @param uriReference
62       the textual representation of the scheme-specific part.
63
64       @returns
65       an object that supports
66       <type scope="com::sun::star::uri">XUriReference</type> (and possibly also
67       additional, scheme-specific interfaces), if the given input can be parsed
68       into an absolute URI; otherwise, <NULL/> is returned.
69     */
70    XUriReference parse([in] string scheme, [in] string schemeSpecificPart);
71};
72
73}; }; }; };
74
75#endif
76