---

IInspectDocument.h

Go to the documentation of this file.

/**
* @file         IInspectDocument.h
* @brief    ドキュメント検査を行うインターフェイス
*
* @author       Nakashima h
* @date     2022-05-01
*
* $Id: IInspectDocument.h 32 2022-07-14 03:20:43Z shingo.yoneda $
*
* Copyright (c) 2022 Antenna House, Inc. All rights reserved.
*/

#pragma once
#include <queue>
#include <memory>
#include <string>
#include "InspectDocumentResult.h"
#include "InspectDocumentRemoveOptions.h"

/**
* @brief    ドキュメント検査を行うインターフェイス
*/
class IInspectDocument {
protected:
    /**
    * @brief    デフォルトコンストラクタ
    */
    IInspectDocument() = default;

    /**
    * @brief    コピーコンストラクタ
    */
    IInspectDocument(const IInspectDocument&) = delete;
    /**
    * @brief    コピー代入演算子
    */
    IInspectDocument& operator=(const IInspectDocument&) = delete;

    /**
    * @brief    ムーブコンストラクタ
    */
    IInspectDocument(IInspectDocument&&) = delete;
    /**
    * @brief    ムーブ代入演算子
    */
    IInspectDocument& operator=(IInspectDocument&&) = delete;

public:

    /**
    * @brief    デストラクタ
    */
    virtual ~IInspectDocument() = default;

    /**
    * @brief    ドキュメント検査を行うオブジェクトを生成する
    * @return ドキュメント検査を行うオブジェクト
    */
    static std::unique_ptr<IInspectDocument> create();

    /**
    * @brief    ドキュメント検査対象のファイルを設定
    * @param inspectedWordPath - ドキュメント検査対象のファイルのパス
    */
    virtual void setInspectedWord(std::string const& inspectedWordPath) = 0;

    /**
    * @brief    ドキュメント検査を実行する
    * @return ドキュメント検査の結果
    */
    virtual InspectDocumentResult executeInspectDocument() = 0;

    /**
    * @brief    ドキュメント検査を実行する
    * @param inspectedWordPath - ドキュメント検査対象のファイルのパス
    * @return ドキュメント検査の結果
    */
    virtual InspectDocumentResult executeInspectDocument(std::string const& inspectedWordPath) = 0;

    /**
    * @brief    メタ情報を削除する
    * @param removeOptions ドキュメント検査の削除対象のオプション
    * @param outputPath 削除結果の出力パス
    */
    virtual void removeMetaInformations(InspectDocumentRemoveOptions removeOptions, std::string const& outputPath) = 0;

    /**
    * @brief    メタ情報を削除する
    * @param inputPath メタ情報を削除するファイルのパス
    * @param removeOptions ドキュメント検査の削除対象のオプション
    * @param outputPath 削除結果の出力パス
    */
    virtual void removeMetaInformations(std::string const& inputPath, InspectDocumentRemoveOptions removeOptions, std::string const& outputPath) = 0;
};

---