Package cdc.issues.io

Interface IssuesWriter

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IssuesWriter.Settings	Class used to configure writing of issues.

Field Summary

Fields

Modifier and Type	Field	Description
static IssuesWriter.Settings	ALL_DATA_ANSWERS
static IssuesWriter.Settings	ALL_DATA_NO_ANSWERS

Method Summary

Modifier and Type	Method	Description
void	save(IssuesAndAnswers issuesAndAnswers, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller)	Saves a list of issues and associated answers to a file.
static void	save(IssuesAndAnswers issuesAndAnswers, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller, IssuesFactoryFeatures features)	Saves a list of issues and associated answers to a file.
void	save(Project project, Snapshot snapshot, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller)
static void	save(Project project, Snapshot snapshot, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller, IssuesFactoryFeatures features)
default void	save(Project project, Snapshot snapshot, File file, cdc.util.events.ProgressController controller)

Field Detail

ALL_DATA_ANSWERS

static final IssuesWriter.Settings ALL_DATA_ANSWERS

ALL_DATA_NO_ANSWERS

static final IssuesWriter.Settings ALL_DATA_NO_ANSWERS

Method Detail

save

void save(Project project,
          Snapshot snapshot,
          IssuesWriter.Settings settings,
          File file,
          cdc.util.events.ProgressController controller)
   throws IOException

Throws:

IOException

save

default void save(Project project,
                  Snapshot snapshot,
                  File file,
                  cdc.util.events.ProgressController controller)
           throws IOException

Throws:

IOException

save

void save(IssuesAndAnswers issuesAndAnswers,
          IssuesWriter.Settings settings,
          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.

settings - The settings.

file - The file.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

static void save(IssuesAndAnswers issuesAndAnswers,
                 IssuesWriter.Settings settings,
                 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.

settings - The settings.

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(Project project,
                 Snapshot snapshot,
                 IssuesWriter.Settings settings,
                 File file,
                 cdc.util.events.ProgressController controller,
                 IssuesFactoryFeatures features)
          throws IOException

Throws:

IOException