1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__ 24#define __com_sun_star_xml_sax_XFastTokenHandler_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30//============================================================================= 31 32module com { module sun { module star { module xml { module sax { 33 34//============================================================================ 35 36/** interface to translate xml strings to integer tokens. 37 38 <p>An instance of this interface can be registered at a <type>XFastParser</type>. 39 It should be able to translate all xml names (element local names, 40 attribute local names and constant attribute values) to integer tokens. 41 42 A token value must be greater or equal to zero and less than 43 <const>FastToken::NAMESPACE</const>. If a string identifier is not known 44 to this instance, <const>FastToken::DONTKNOW</const> is returned. 45 */ 46interface XFastTokenHandler: com::sun::star::uno::XInterface 47{ 48 //------------------------------------------------------------------------- 49 50 /** returns a integer token for the given string identifier. 51 52 @returns 53 a unique integer token for the given String or <const>FastToken::DONTKNOW</const> 54 if the identifier is not known to this instance. 55 */ 56 long getToken( [in] string Identifier ); 57 58 //------------------------------------------------------------------------- 59 60 /** returns a string identifier for the given integer token. 61 */ 62 string getIdentifier( [in] long Token ); 63 64 //------------------------------------------------------------------------- 65 66 /** returns a integer token for the given string 67 68 @param Identifier 69 the string given as a byte sequence encoded in UTF8 70 71 @returns 72 a unique integer token for the given String or <const>FastToken::DONTKNOW</const> 73 if the identifier is not known to this instance. 74 */ 75 long getTokenFromUTF8( [in] sequence< byte > Identifier ); 76 77 //------------------------------------------------------------------------- 78 79 /** returns a identifier for the given integer token as a byte 80 sequence encoded in UTF8. 81 */ 82 sequence< byte > getUTF8Identifier( [in] long Token ); 83}; 84 85//============================================================================ 86 87}; }; }; }; }; 88 89#endif 90