source: NonGTP/Xerces/xercesc/util/HashBase.hpp @ 188

Revision 188, 4.3 KB checked in by mattausch, 19 years ago (diff)

added xercesc to support

Line 
1/*
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in
16 *    the documentation and/or other materials provided with the
17 *    distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 *    if any, must include the following acknowledgment:
21 *       "This product includes software developed by the
22 *        Apache Software Foundation (http://www.apache.org/)."
23 *    Alternately, this acknowledgment may appear in the software itself,
24 *    if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "Xerces" and "Apache Software Foundation" must
27 *    not be used to endorse or promote products derived from this
28 *    software without prior written permission. For written
29 *    permission, please contact apache\@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache",
32 *    nor may "Apache" appear in their name, without prior written
33 *    permission of the Apache Software Foundation.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation, and was
51 * originally based on software copyright (c) 1999, International
52 * Business Machines, Inc., http://www.ibm.com .  For more information
53 * on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57#if !defined(HASHBASE_HPP)
58#define HASHBASE_HPP
59
60#include <xercesc/util/XMemory.hpp>
61#include <xercesc/util/PlatformUtils.hpp>
62
63XERCES_CPP_NAMESPACE_BEGIN
64
65/**
66 * The <code>HashBase</code> interface is the general outline of a hasher.
67 * Hashers are used in <code>RefHashTableOf</code> hashtables to hash any
68 * type of key.  An examples is the <code>HashXMLCh</code> class which is
69 * designed to produce hash values for XMLCh* strings.  Any hasher inheriting
70 * from <code>HashBase</code> may be specified when the RefHashTableOf hashtable is constructed.
71 */
72class XMLUTIL_EXPORT HashBase : public XMemory
73{
74
75public:
76       
77        /**
78      * Returns a hash value based on the key
79      *
80      * @param key the key to be hashed
81          * @param mod the modulus the hasher should use
82      */
83        virtual unsigned int getHashVal(const void *const key, unsigned int mod
84        , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager) = 0;
85
86        /**
87      * Compares two keys and determines if they are semantically equal
88      *
89      * @param key1 the first key to be compared
90          * @param key2 the second key to be compared
91          *
92          * @return true if they are equal
93      */
94        virtual bool equals(const void *const key1, const void *const key2) = 0;
95
96    virtual ~HashBase() {};
97
98    HashBase() {};
99
100private:
101        // -----------------------------------------------------------------------
102    //  Unimplemented constructors and operators
103    // -----------------------------------------------------------------------
104    HashBase(const HashBase&);
105    HashBase& operator=(const HashBase&);   
106};
107
108XERCES_CPP_NAMESPACE_END
109
110#endif
Note: See TracBrowser for help on using the repository browser.