/*
 * @project      The CERN Tape Archive (CTA)
 * @copyright    Copyright © 2021-2022 CERN
 * @license      This program is free software, distributed under the terms of the GNU General Public
 *               Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING". You can
 *               redistribute it and/or modify it under the terms of the GPL Version 3, or (at your
 *               option) any later version.
 *
 *               This program is distributed in the hope that it will be useful, but WITHOUT ANY
 *               WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 *               PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 *               In applying this licence, CERN does not waive the privileges and immunities
 *               granted to it by virtue of its status as an Intergovernmental Organization or
 *               submit itself to any jurisdiction.
 */

#pragma once

#include <string>
#include "common/exception/Exception.hpp"

namespace cta::exception {

/**
 * Invalid configuration entry exception.
 */
class InvalidConfigEntry : public Exception {
public:
  /**
   * Constructor
   *
   * @param catagory   The category of the configuration entry.
   * @param entryName  The name of the configuration entry.
   * @param entryValue The (invalid) value of the configuration entry.
   */
  InvalidConfigEntry(const char* const category, const char* const entryName, const char* const entryValue);

  /**
   * Trivial destructor (required through inheritence from std::exception) 
   */
  ~InvalidConfigEntry() final = default;
      
  /**
   * Returns the category of the configuration entry.
   */
  const std::string& getEntryCategory();

  /**
   * Returns the name of the configuration entry.
   */
  const std::string& getEntryName();

  /**
   * Returns the (invalid) value of the configuration entry.
   */
  const std::string& getEntryValue();

private:
  /**
   * The category of the configuration entry.
   */
  const std::string m_entryCategory;

  /**
   * The name of the configuration entry.
   */
  const std::string m_entryName;

  /**
   * The (invalid) value of the configuration entry.
   */
  const std::string m_entryValue;
};

} // namespace cta::exception