Package cdc.issues.io

Interface IssuesWriter

public interface IssuesWriter

Interface implemented by classes that can save Issues, Answers, Project, Snapshot to a File or an OutputStream.

One must use IssuesIoFactory.createIssuesWriter(File) or IssuesIoFactory.createIssuesWriter(OutputStream, IssuesFormat) to create an instance of IssuesWriter.

There are 2 modes of generation:

1. Issues and Answers mode.
2. Project, Profile and Snapshot mode.

Author:

Damien Carbonne

See Also:

• IssuesFormat

Method Summary

Modifier and Type	Method	Description
void	save(IssuesAndAnswers issuesAndAnswers, OutSettings settings, cdc.util.events.ProgressController controller)	Saves a list of issues and associated answers.
static void	save(IssuesAndAnswers issuesAndAnswers, OutSettings settings, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues and associated answers to a file.
static void	save(IssuesAndAnswers issuesAndAnswers, OutSettings settings, OutputStream out, IssuesFormat format, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues and associated answers to an output stream.
void	save(SnapshotData synthesis, IssuesAndAnswers issuesAndAnswers, OutSettings settings, cdc.util.events.ProgressController controller)	Saves snapshot data, a list of issues and associated answers.
void	save(SnapshotData synthesis, List<? extends Issue> issues, OutSettings settings, cdc.util.events.ProgressController controller)	Saves snapshot data and a list of issues.
static void	save(SnapshotData synthesis, List<? extends Issue> issues, OutSettings settings, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves snapshot data and a list of issues to a file.
void	save(Snapshot snapshot, OutSettings settings, cdc.util.events.ProgressController controller)	Saves a project and snapshot to a file.
static void	save(Snapshot snapshot, OutSettings settings, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a project and snapshot to a file.
void	save(List<? extends Issue> issues, OutSettings settings, cdc.util.events.ProgressController controller)	Saves a list of issues.
static void	save(List<? extends Issue> issues, OutSettings settings, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues to a file.
static void	save(List<? extends Issue> issues, OutSettings settings, OutputStream out, IssuesFormat format, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues to an output stream.
static void	save(List<? extends Issue> issues, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues to a file using OutSettings.ALL_DATA_NO_ANSWERS settings.
static void	save(List<? extends Issue> issues, OutputStream out, IssuesFormat format, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues to an output stream.

Method Details

save

void save(IssuesAndAnswers issuesAndAnswers,
 OutSettings settings,
 cdc.util.events.ProgressController controller)
   throws IOException

Saves a list of issues and associated answers.

Issues and Answers mode.

Parameters:

issuesAndAnswers - The issues and answers.

settings - The settings.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

void save(List<? extends Issue> issues,
 OutSettings settings,
 cdc.util.events.ProgressController controller)
   throws IOException

Saves a list of issues.

Issues and Answers mode.

Parameters:

issues - The issues.

settings - The settings.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

void save(Snapshot snapshot,
 OutSettings settings,
 cdc.util.events.ProgressController controller)
   throws IOException

Saves a project and snapshot to a file.

Project, Profile and Snapshot mode.

Parameters:

snapshot - The snapshot.

settings - The settings.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

void save(SnapshotData synthesis,
 List<? extends Issue> issues,
 OutSettings settings,
 cdc.util.events.ProgressController controller)
   throws IOException

Saves snapshot data and a list of issues.

Project, Profile and Snapshot mode.

WARNING: no check is done that synthesis and issues are consistent.

Parameters:

synthesis - The snapshot data.

issues - The issues.

settings - The settings.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

void save(SnapshotData synthesis,
 IssuesAndAnswers issuesAndAnswers,
 OutSettings settings,
 cdc.util.events.ProgressController controller)
   throws IOException

Saves snapshot data, a list of issues and associated answers.

Project, Profile and Snapshot mode.

WARNING: no check is done that synthesis and issuesAndAnswers are consistent.

Parameters:

synthesis - The snapshot data.

issuesAndAnswers - The issues and answers.

settings - The settings.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

static void save(IssuesAndAnswers issuesAndAnswers,
 OutSettings settings,
 File file,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues and associated answers to a file.

Issues and Answers mode.

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(List<? extends Issue> issues,
 OutSettings settings,
 File file,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues to a file.

Issues and Answers mode.

Parameters:

issues - The issues.

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(List<? extends Issue> issues,
 File file,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues to a file using OutSettings.ALL_DATA_NO_ANSWERS settings.

Issues and Answers mode.

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(Snapshot snapshot,
 OutSettings settings,
 File file,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a project and snapshot to a file.

Project, Profile and Snapshot mode.

Parameters:

snapshot - The snapshot It should belong to project.

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(IssuesAndAnswers issuesAndAnswers,
 OutSettings settings,
 OutputStream out,
 IssuesFormat format,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues and associated answers to an output stream.

Issues and Answers mode.

Parameters:

issuesAndAnswers - The issues and answers.

settings - The settings.

out - The output stream.

format - The output format.

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,
 OutSettings settings,
 OutputStream out,
 IssuesFormat format,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues to an output stream.

Issues and Answers mode.

Parameters:

issues - The issues.

settings - The settings.

out - The output stream.

format - The output format.

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,
 OutputStream out,
 IssuesFormat format,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues to an output stream.

Issues and Answers mode.

Parameters:

issues - The issues.

out - The output stream.

format - The output format.

controller - The progress controller.

features - The features used to configure file generation.

Throws:

IOException - When an IO error occurs.

save

static void save(SnapshotData synthesis,
 List<? extends Issue> issues,
 OutSettings settings,
 File file,
 cdc.util.events.ProgressController controller,
 IssuesIoFactoryFeatures features)
          throws IOException

Saves snapshot data and a list of issues to a file.

Project, Profile and Snapshot mode.

Parameters:

synthesis - The snapshot data.

issues - The issues.

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.