udkapi/com/sun/star/uri/UriReferenceFactory.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 published interface XUriReferenceFactory;
  23
  24 /**
  25    creates URI references.
  26
  27    <p>See <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC&nbsp;3986</a> for a
  28    description of URI references and related terms.</p>
  29
  30    <p>For parsing absolute URI references, this service tries to use a
  31    scheme-specific parser.  Such a scheme-specific parser will typically enforce
  32    additional restrictions during parsing, and will typically return objects
  33    that support extra, scheme-specific interfaces in addition to
  34    com::sun::star::uri::XUriReference.  If no such parser
  35    is found, and for relative URI references, a generic parser is used, which
  36    returns objects that only support
  37    com::sun::star::uri::XUriReference.</p>
  38
  39    <p>Locating a scheme-specific parser works as follows:  A scheme consists of
  40    Latin capital letters
  41    &ldquo;<code>A</code>&rdquo;&ndash;&ldquo;<code>Z</code>&rdquo;, Latin small
  42    letters &ldquo;<code>a</code>&rdquo;&ndash;&ldquo;<code>z</code>&rdquo;,
  43    digits &ldquo;<code>0</code>&rdquo;&ndash;&ldquo;<code>9</code>&rdquo;,
  44    &ldquo;<code>+</code>&rdquo;, &ldquo;<code>-</code>&rdquo;, and
  45    &ldquo;<code>.</code>&rdquo;.  A scheme&nbsp;<var>s</var> is transformed into
  46    a string&nbsp;<var>s</var>&prime; character-by-character, by translating
  47    Latin capital letters to their small counterparts, translating
  48    &ldquo;<code>+</code>&rdquo; to &ldquo;<code>PLUS</code>&rdquo;,
  49    &ldquo;<code>-</code>&rdquo; to &ldquo;<code>HYPHEN</code>&rdquo;,
  50    &ldquo;<code>.</code>&rdquo; to &ldquo;<code>DOT</code>&rdquo;, and copying
  51    Latin small letters and digits unchanged.  If the component context used
  52    while creating this <code>UriReferenceFactory</code> instance offers a
  53    service manager, and there is a service available at that service manager
  54    whose name is the concatenation of
  55    &ldquo;<code>com.sun.star.uri.UriSchemeParser_</code>&rdquo; and
  56    <var>s</var>&prime;, then that service is used.  It is an error if that
  57    service does not support
  58    com::sun::star::uri::XUriSchemeParser.</p>
  59
  60    @since OOo 2.0
  61  */
  62 published service UriReferenceFactory: XUriReferenceFactory;
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */