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 module com { module sun { module star { module uri {
  21
  22 /**
  23    parses textual representations of absolute URIs.
  24
  25    <p>See <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC&nbsp;3986</a> for a
  26    description of URIs and related terms.</p>
  27
  28    @since OOo 2.0
  29  */
  30 published interface XUriSchemeParser: com::sun::star::uno::XInterface {
  31     /**
  32        parses the textual representation of an absolute URI.
  33
  34        <p>This method is used to parse URIs (with no fragment part), not URI
  35        references (with an optional fragment part).</p>
  36
  37        <p>If an object is returned, the behaviour of its
  38        com::sun::star::uri::XUriReference methods must
  39        reflect the fact that the object represents an absolute URI reference
  40        with the given scheme and scheme-specific part, and without a fragment
  41        part.</p>
  42
  43        @param scheme
  44        the textual representation of the scheme part (without the delimiting
  45        &ldquo;<code>:</code>&rdquo;).
  46
  47        @param schemeSpecificPart
  48        the textual representation of the scheme-specific part.
  49
  50        @returns
  51        an object that supports
  52        com::sun::star::uri::XUriReference (and possibly also
  53        additional, scheme-specific interfaces), if the given input can be parsed
  54        into an absolute URI; otherwise, `NULL` is returned.
  55      */
  56     XUriReference parse([in] string scheme, [in] string schemeSpecificPart);
  57 };
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */