Package cdc.issues.io

Interface IssuesWriter

  • Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface IssuesWriter
    Interface implemented by classes that can save Issues to a file.

    One must use IssuesFactory.createIssuesWriter(File) to create an instance of IssuesWriter.

    Author:
    Damien Carbonne
    • Method Detail

      • save

        void save​(List<? extends Issue> issues,
                  Function<IssueId,​IssueAnswer> answersSupplier,
                  File file,
                  cdc.util.events.ProgressController controller)
           throws IOException
        Saves a list of issues and associated answers to a file.
        Parameters:
        issues - The list of issues.
        answersSupplier - The supplier of answers.
        file - The file.
        controller - The progress controller.
        Throws:
        IOException - When an IO error occurs.
      • save

        default void save​(IssuesAndAnswers issuesAndAnswers,
                          boolean saveAnswers,
                          File file,
                          cdc.util.events.ProgressController controller)
                   throws IOException
        Saves a list of issues and associated answers to a file.
        Parameters:
        issuesAndAnswers - The issues and answers.
        saveAnswers - If true, answers are saved.
        file - The file.
        controller - The progress controller.
        Throws:
        IOException - When an IO error occurs.
      • save

        default void save​(List<? extends Issue> issues,
                          File file,
                          cdc.util.events.ProgressController controller)
                   throws IOException
        Saves a list of issues to a file.
        Parameters:
        issues - The list of issues.
        file - The file.
        controller - The progress controller.
        Throws:
        IOException - When an IO error occurs.
      • save

        static void save​(List<? extends Issue> issues,
                         File file,
                         cdc.util.events.ProgressController controller,
                         IssuesFactoryFeatures features)
                  throws IOException
        Saves a list of issues to a file.
        Parameters:
        issues - The issues.
        file - The file.
        controller - The progress controller.
        features - The features used to configure file generation.
        Throws:
        IOException - When an IO error occurs.
      • save

        static void save​(List<? extends Issue> issues,
                         Function<IssueId,​IssueAnswer> answersSupplier,
                         File file,
                         cdc.util.events.ProgressController controller,
                         IssuesFactoryFeatures features)
                  throws IOException
        Saves a list of issues and associated answers to a file.
        Parameters:
        issues - The issues.
        answersSupplier - The supplier of answers.
        file - The file.
        controller - The progress controller.
        features - The features used to configure file generation.
        Throws:
        IOException - When an IO error occurs.
      • save

        static void save​(IssuesAndAnswers issuesAndAnswers,
                         boolean saveAnswers,
                         File file,
                         cdc.util.events.ProgressController controller,
                         IssuesFactoryFeatures features)
                  throws IOException
        Saves a list of issues and associated answers to a file.
        Parameters:
        issuesAndAnswers - The issues and answers.
        saveAnswers - If true, answers are saved.
        file - The file.
        controller - The progress controller.
        features - The features used to configure file generation.
        Throws:
        IOException - When an IO error occurs.