utility/HashError.hpp

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 **/

#ifndef QUICKSTEP_UTILITY_HASH_ERROR_HPP_
#define QUICKSTEP_UTILITY_HASH_ERROR_HPP_

#include <exception>
#include <string>

namespace quickstep {

/** \addtogroup Utility
 *  @{
 */

/**
 * @brief Exception thrown for non-supported hash().
 **/
class HashNotSupported : public std::exception {
 public:
  /**
   * @brief Constructor.
   *
   * @param message The error message.
   **/
  explicit HashNotSupported(const std::string &message)
      : message_(message) {}

  /**
   * @brief Destructor.
   */
  ~HashNotSupported() throw() {}

  virtual const char* what() const throw() {
    return message_.c_str();
  }

 private:
  const std::string message_;
};

/** @} */

}  // namespace quickstep

#endif  // QUICKSTEP_UTILITY_HASH_ERROR_HPP_