Package cdc.issues.io

Interface IssuesWriter

public interface IssuesWriter

Interface implemented by classes that can save Issues, Answers, Project, Snapshot to a file.

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

There are 2 modes of generation:

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

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, IssuesIoFactoryFeatures features)	Saves a list of issues and associated answers to a file.
void	save(Snapshot snapshot, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller)	Saves a project and snapshot to a file.
static void	save(Snapshot snapshot, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a project and snapshot to a file.
void	save(List<? extends Issue> issues, IssuesWriter.Settings settings, File file, cdc.util.events.ProgressController controller)	Saves a list of issues to a file.
static void	save(List<? extends Issue> issues, IssuesWriter.Settings 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, File file, cdc.util.events.ProgressController controller, IssuesIoFactoryFeatures features)	Saves a list of issues to a file using ALL_DATA_NO_ANSWERS settings.

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(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.

Issues & Answers mode.

Parameters:

issuesAndAnswers - The issues and answers.

settings - The settings.

file - The file.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

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

Saves a list of issues to a file.

Issues & Answers mode.

Parameters:

issues - The issues.

settings - The settings.

file - The file.

controller - The progress controller.

Throws:

IOException - When an IO error occurs.

save

void save(Snapshot snapshot,
          IssuesWriter.Settings settings,
          File file,
          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.

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,
                 IssuesIoFactoryFeatures features)
          throws IOException

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

Issues & 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,
                 IssuesWriter.Settings settings,
                 File file,
                 cdc.util.events.ProgressController controller,
                 IssuesIoFactoryFeatures features)
          throws IOException

Saves a list of issues to a file.

Issues & 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 ALL_DATA_NO_ANSWERS settings.

Issues & 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,
                 IssuesWriter.Settings 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.