offapi/com/sun/star/xml/sax/XFastTokenHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFastTokenHandler.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__
  31 #define __com_sun_star_xml_sax_XFastTokenHandler_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module xml {  module sax {
  40
  41 //============================================================================
  42
  43 /** interface to translate xml strings to integer tokens.
  44
  45     <p>An instance of this interface can be registered at a <type>XFastParser</type>.
  46     It should be able to translate all xml names (element local names,
  47     attribute local names and constant attribute values) to integer tokens.
  48
  49     A token value must be greater or equal to zero and less than
  50     <const>FastToken::NAMESPACE</const>. If a string identifier is not known
  51     to this instance, <const>FastToken::DONTKNOW</const> is returned.
  52  */
  53 interface XFastTokenHandler: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** returns a integer token for the given string identifier.
  58
  59         @returns
  60             a unique integer token for the given String or <const>FastToken::DONTKNOW</const>
  61             if the identifier is not known to this instance.
  62     */
  63     long getToken( [in] string Identifier );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** returns a string identifier for the given integer token.
  68     */
  69     string getIdentifier( [in] long Token );
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** returns a integer token for the given string
  74
  75         @param Identifier
  76             the string given as a byte sequence encoded in UTF8
  77
  78         @returns
  79             a unique integer token for the given String or <const>FastToken::DONTKNOW</const>
  80             if the identifier is not known to this instance.
  81     */
  82     long getTokenFromUTF8( [in] sequence< byte > Identifier );
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** returns a identifier for the given integer token as a byte
  87           sequence encoded in UTF8.
  88     */
  89     sequence< byte > getUTF8Identifier( [in] long Token );
  90 };
  91
  92 //============================================================================
  93
  94 }; }; }; }; };
  95
  96 #endif