---

IInspectDocument.h

Go to the documentation of this file.

/**
* @file         IInspectDocument.h
* @brief    Interface to perform inspect document
*
* @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    Interface to perform inspect document
*/
class IInspectDocument {
protected:
    /**
    * @brief    Default constructor
    */
    IInspectDocument() = default;

    /**
    * @brief    Copy constructor
    */
    IInspectDocument(const IInspectDocument&) = delete;
    /**
    * @brief    Copy assignment operator
    */
    IInspectDocument& operator=(const IInspectDocument&) = delete;

    /**
    * @brief    Move constructor
    */
    IInspectDocument(IInspectDocument&&) = delete;
    /**
    * @brief    Move assignment operator
    */
    IInspectDocument& operator=(IInspectDocument&&) = delete;

public:

    /**
    * @brief    Destructor
    */
    virtual ~IInspectDocument() = default;

    /**
    * @brief    Generate an object to perform inspect document
    * @return Object to perform inspect document
    */
    static std::unique_ptr<IInspectDocument> create();

    /**
    * @brief    Set target file of inspect document
    * @param inspectedWordPath - Path of the target file of inspect document
    */
    virtual void setInspectedWord(std::string const& inspectedWordPath) = 0;

    /**
    * @brief    Perform inspect document
    * @return Inspect document results
    */
    virtual InspectDocumentResult executeInspectDocument() = 0;

    /**
    * @brief    Perform inspect document
    * @param inspectedWordPath - Path of the target file of inspect document
    * @return Inspect document results
    */
    virtual InspectDocumentResult executeInspectDocument(std::string const& inspectedWordPath) = 0;

    /**
    * @brief    Remove meta information
    * @param removeOptions Options for removing target in inspect document
    * @param outputPath Output path of removing result
    */
    virtual void removeMetaInformations(InspectDocumentRemoveOptions removeOptions, std::string const& outputPath) = 0;

    /**
    * @brief    Remove meta information
    * @param inputPath Path of the file from which the meta information is to be removed
    * @param removeOptions Options for removing target in inspect document
    * @param outputPath Output path of removing result
    */
    virtual void removeMetaInformations(std::string const& inputPath, InspectDocumentRemoveOptions removeOptions, std::string const& outputPath) = 0;
};

---