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