udkapi/com/sun/star/uri/XUriSchemeParser.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_uri_XUriSchemeParser_idl__
  21 #define __com_sun_star_uri_XUriSchemeParser_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/uri/XUriReference.idl>
  25
  26 module com { module sun { module star { module uri {
  27
  28 /**
  29    parses textual representations of absolute URIs.
  30
  31    <p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a> for a
  32    description of URIs and related terms.</p>
  33
  34    @since OOo 2.0
  35  */
  36 published interface XUriSchemeParser: com::sun::star::uno::XInterface {
  37     /**
  38        parses the textual representation of an absolute URI.
  39
  40        <p>This method is used to parse URIs (with no fragment part), not URI
  41        references (with an optional fragment part).</p>
  42
  43        <p>If an object is returned, the behaviour of its
  44        com::sun::star::uri::XUriReference methods must
  45        reflect the fact that the object represents an absolute URI reference
  46        with the given scheme and scheme-specific part, and without a fragment
  47        part.</p>
  48
  49        @param scheme
  50        the textual representation of the scheme part (without the delimiting
  51        &ldquo;<code>:</code>&rdquo;).
  52
  53        @param schemeSpecificPart
  54        the textual representation of the scheme-specific part.
  55
  56        @returns
  57        an object that supports
  58        com::sun::star::uri::XUriReference (and possibly also
  59        additional, scheme-specific interfaces), if the given input can be parsed
  60        into an absolute URI; otherwise, `NULL` is returned.
  61      */
  62     XUriReference parse([in] string scheme, [in] string schemeSpecificPart);
  63 };
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */