net.paissad.tools.reqcoco.core.report

Class ReqReportBuilderJson

java.lang.Object

net.paissad.tools.reqcoco.core.report.AbstractReqReportBuilder

net.paissad.tools.reqcoco.core.report.ReqReportBuilderJson

All Implemented Interfaces:

ReqReportBuilder

public class ReqReportBuilderJson
extends AbstractReqReportBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_REPORT_FILE_DEFAULT_EXTENSION The default extension for the JSON report builder.

Fields inherited from class net.paissad.tools.reqcoco.core.report.AbstractReqReportBuilder

DEFAULT_REPORT_FILENAME_WITHOUT_EXTENSION

Constructor Summary

Constructors

Constructor and Description
ReqReportBuilderJson(Path reportOutputDirPath)
ReqReportBuilderJson(Path reportOutputDirPath, String reportFilename)

Method Summary

Modifier and Type	Method and Description
void	configure(Collection<Requirement> requirements, ReqReportConfig config)
protected String	getDefaultFileReportExtension()
void	run()

Methods inherited from class net.paissad.tools.reqcoco.core.report.AbstractReqReportBuilder

buildReqReports, getCodeDoneCount, getCodeDoneCount, getCodeDoneRatio, getCodeDoneRatio, getCodeUndoneCount, getCodeUndoneCount, getDefaultReportConfig, getDefaultReportFilename, getIgnoredRequirementsCount, getIgnoredRequirementsCount, getRequirementByVersion, getRequirementsIgnoredRatio, getTestDoneRatio, getTestDoneRatio, getTestsDoneCount, getTestsDoneCount, getTestsUndoneCount, getTestsUndoneCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JSON_REPORT_FILE_DEFAULT_EXTENSION

public static final String JSON_REPORT_FILE_DEFAULT_EXTENSION

The default extension for the JSON report builder.

See Also:

Constant Field Values

Constructor Detail

ReqReportBuilderJson

public ReqReportBuilderJson(Path reportOutputDirPath)

Parameters:

reportOutputDirPath - - The directory where to generate the report.

See Also:

ReqReportBuilderJson(Path, String)

ReqReportBuilderJson

public ReqReportBuilderJson(Path reportOutputDirPath,
                            String reportFilename)

Parameters:

reportOutputDirPath - - The directory where to generate the report.

reportFilename - - The name of the output JSON output file to generate. If null or blank, the default name will be used.

Method Detail

configure

public void configure(Collection<Requirement> requirements,
                      ReqReportConfig config)
               throws ReqReportBuilderException

Specified by:

configure in interface ReqReportBuilder

Overrides:

configure in class AbstractReqReportBuilder

Throws:

ReqReportBuilderException

run

public void run()
         throws ReqReportBuilderException

Throws:

ReqReportBuilderException

getDefaultFileReportExtension

protected String getDefaultFileReportExtension()

Specified by:

getDefaultFileReportExtension in class AbstractReqReportBuilder

Returns:

The default expected extension to use for the report filename if needed.