ls-standard-library/include/ls-std/io/section-pair/reader/SectionPairFileReaderParameter.hpp

/*
* Author:          Patrick-Christopher Mattulat
* Company:         Lynar Studios
* E-Mail:          webmaster@lynarstudios.com
* Created:         2023-02-21
* Changed:         2024-09-13
*
* */

#ifndef LS_STD_SECTION_PAIR_FILE_READER_PARAMETER_HPP
#define LS_STD_SECTION_PAIR_FILE_READER_PARAMETER_HPP

#include <ls-std/core/interface/IEvaluator.hpp>
#include <ls-std/core/interface/IReader.hpp>
#include <ls-std/io/section-pair/model/SectionPairDocument.hpp>
#include <ls-std/os/dynamic-goal.hpp>
#include <memory>
#include <string>
#include <string_view>

/*
 * @doc: class(name: 'SectionPairFileReaderParameter', package: 'io')
 * @doc: io.SectionPairFileReaderParameter.description('This class holds evaluators and the document instance for Section Pair file reading.')
 * */

namespace ls::std::io
{
  class LS_STD_DYNAMIC_GOAL SectionPairFileReaderParameter
  {
    public:

      SectionPairFileReaderParameter();
      ~SectionPairFileReaderParameter();

      [[nodiscard]] ::std::shared_ptr<ls::std::io::SectionPairDocument> getDocument() const;
      [[nodiscard]] ::std::shared_ptr<ls::std::core::interface_type::IEvaluator> getFileExistenceEvaluator() const;
      [[nodiscard]] ::std::string getFilePath() const;
      [[nodiscard]] ::std::shared_ptr<ls::std::core::interface_type::IReader> getReader() const;
      void setDocument(const ::std::shared_ptr<ls::std::io::SectionPairDocument> &_document);
      void setFileExistenceEvaluator(const ::std::shared_ptr<ls::std::core::interface_type::IEvaluator> &_fileExistenceEvaluator);
      void setFilePath(::std::string_view _filePath);
      void setReader(const ::std::shared_ptr<ls::std::core::interface_type::IReader> &_reader);

    private:

      ::std::shared_ptr<ls::std::io::SectionPairDocument> document{};
      ::std::shared_ptr<ls::std::core::interface_type::IEvaluator> fileExistenceEvaluator{};
      ::std::string filePath{};
      ::std::shared_ptr<ls::std::core::interface_type::IReader> reader{};
  };
}

#endif