HashBase.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:4k
- /*
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Xerces" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation, and was
- * originally based on software copyright (c) 1999, International
- * Business Machines, Inc., http://www.ibm.com . For more information
- * on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
- #if !defined(HASHBASE_HPP)
- #define HASHBASE_HPP
- #include <xercesc/util/XMemory.hpp>
- XERCES_CPP_NAMESPACE_BEGIN
- /**
- * The <code>HashBase</code> interface is the general outline of a hasher.
- * Hashers are used in <code>RefHashTableOf</code> hashtables to hash any
- * type of key. An examples is the <code>HashXMLCh</code> class which is
- * designed to produce hash values for XMLCh* strings. Any hasher inheriting
- * from <code>HashBase</code> may be specified when the RefHashTableOf hashtable is constructed.
- */
- class XMLUTIL_EXPORT HashBase : public XMemory
- {
- public:
-
- /**
- * Returns a hash value based on the key
- *
- * @param key the key to be hashed
- * @param mod the modulus the hasher should use
- */
- virtual unsigned int getHashVal(const void *const key, unsigned int mod) = 0;
- /**
- * Compares two keys and determines if they are semantically equal
- *
- * @param key1 the first key to be compared
- * @param key2 the second key to be compared
- *
- * @return true if they are equal
- */
- virtual bool equals(const void *const key1, const void *const key2) = 0;
- };
- XERCES_CPP_NAMESPACE_END
- #endif