Class DoctorReportWriter

java.lang.Object

com.shaft.doctor.report.DoctorReportWriter

public final class DoctorReportWriter
extends Object

Writes deterministic human-readable Doctor reports.

Constructor Summary

Constructors

Constructor	Description
DoctorReportWriter()

Method Summary

Modifier and Type	Method	Description
void	writeMarkdown(Path path, EvidenceBundle bundle, Diagnosis diagnosis)	Writes a Markdown report.
void	writeMarkdown(Path path, EvidenceBundle bundle, Diagnosis diagnosis, DoctorAdvisory advisory)	Writes a Markdown report with a separately identified optional advisory.

Methods inherited from class Object

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

Constructor Details

DoctorReportWriter

public DoctorReportWriter()

Method Details

writeMarkdown

public void writeMarkdown(Path path,
 EvidenceBundle bundle,
 Diagnosis diagnosis)

Writes a Markdown report.

Parameters:

path - destination

bundle - evidence bundle

diagnosis - diagnosis

writeMarkdown

public void writeMarkdown(Path path,
 EvidenceBundle bundle,
 Diagnosis diagnosis,
 DoctorAdvisory advisory)

Writes a Markdown report with a separately identified optional advisory.

Parameters:

path - destination

bundle - evidence bundle

diagnosis - deterministic diagnosis

advisory - optional provider advisory