com.credibledoc.substitution.reporting.reportdocument

Interface ReportDocument

All Superinterfaces:

Printable

All Known Implementing Classes:

Document

public interface ReportDocument
extends Printable

Contains a state of a single report document during its generation. ReportDocument can be a representation of a markdown file, html file, UML diagram and so on.

Author:

Kyrylo Semenko

Method Summary

Modifier and Type	Method and Description
Consumer<ReportDocument>	getFooterMethod()
Set<NodeFile>	getNodeFiles()
Report	getReport()
Class<? extends ReportDocumentType>	getReportDocumentType()
void	setReport(Report report)

Methods inherited from interface com.credibledoc.enricher.printable.Printable

checkAllLineProcessors, getCacheLines, getPrintWriter

Method Detail

getFooterMethod

Consumer<ReportDocument> getFooterMethod()

Returns:

A method for filling out this ReportDocument. This method will be called as the last method before closing of Printable.getPrintWriter() object.

getReportDocumentType

Class<? extends ReportDocumentType> getReportDocumentType()

Returns:

A ReportDocumentType this ReportDocument belongs to.

getNodeFiles

Set<NodeFile> getNodeFiles()

Returns:

Set of NodeFiles this ReportDocument obtain data from.

getReport

Report getReport()

Returns:

The Report this ReportDocument belongs to.

setReport

void setReport(Report report)

Parameters:

report - the Report instance this ReportDocument will be belonging to.