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