offapi/com/sun/star/xml/sax/XFastTokenHandler.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 #ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__
  20 #define __com_sun_star_xml_sax_XFastTokenHandler_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25 module com {  module sun {  module star {  module xml {  module sax {
  26
  27
  28 /** interface to translate XML strings to integer tokens.
  29
  30     <p>An instance of this interface can be registered at a XFastParser.
  31     It should be able to translate all XML names (element local names,
  32     attribute local names and constant attribute values) to integer tokens.
  33
  34     A token value must be greater or equal to zero and less than
  35     FastToken::NAMESPACE. If a string identifier is not known
  36     to this instance, FastToken::DONTKNOW is returned.
  37  */
  38 interface XFastTokenHandler: com::sun::star::uno::XInterface
  39 {
  40
  41     /** returns a integer token for the given string
  42
  43         @param Identifier
  44             the string given as a byte sequence encoded in UTF-8
  45
  46         @returns
  47             a unique integer token for the given String or FastToken::DONTKNOW
  48             if the identifier is not known to this instance.
  49     */
  50     long getTokenFromUTF8( [in] sequence< byte > Identifier );
  51
  52
  53     /** returns a identifier for the given integer token as a byte
  54           sequence encoded in UTF-8.
  55     */
  56     sequence< byte > getUTF8Identifier( [in] long Token );
  57 };
  58
  59
  60 }; }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */