Package dev.aherscu.qa.jgiven.reporter

Class QaJGivenReportModel<T>

java.lang.Object

dev.aherscu.qa.jgiven.reporter.QaJGivenReportModel<T>

Type Parameters:

T - one of JGiven's report models: CompleteReportModel, ScenarioModel, or ReportModelFile

public class QaJGivenReportModel<T>
extends Object

Reporting model, comprising JGiven's report model, additional fields and Mustache template methods. The reporting model contains all information that can be used to generate a report. Template methods can be used for more advanced manipulation that cannot be handled by out-of-the-box Mustache engine functions.

Reporters may use it as is, or extend it with even more fields and template methods per need.

Reports are generated by invoking the Mustache engine with a specific template and a report model.

See Also:

AbstractQaJgivenReporter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QaJGivenReportModel.QaJGivenReportModelBuilder<T,C extends QaJGivenReportModel<T>,B extends QaJGivenReportModel.QaJGivenReportModelBuilder<T,C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
com.samskivert.mustache.Mustache.Lambda	asId
String	datePattern
com.samskivert.mustache.Mustache.Lambda	deleteEOL
com.samskivert.mustache.Mustache.Lambda	isStepFailed
com.samskivert.mustache.Mustache.Lambda	isStepPassed
T	jgivenReport
com.samskivert.mustache.Mustache.Lambda	nanoToMillis
String	planDocumentId
String	planDocumentRev
String	productName
String	productVersion
com.samskivert.mustache.Mustache.Lambda	scaleImage
String	screenshotScale
com.samskivert.mustache.Mustache.Lambda	shorten
com.samskivert.mustache.Mustache.Lambda	simpleName
String	specDocumentId
String	specDocumentRev
File	targetReportFile
String	testDocumentId
String	testDocumentRev
String	traceabilityDocumentId
String	traceabilityDocumentRev
com.samskivert.mustache.Mustache.Lambda	translateIntroWord

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QaJGivenReportModel(QaJGivenReportModel.QaJGivenReportModelBuilder<T,?,?> b)

Method Summary

Modifier and Type	Method	Description
static <T> QaJGivenReportModel.QaJGivenReportModelBuilder<T,?,?>	builder()
String	date()
void	scaleImage(com.samskivert.mustache.Template.Fragment frag, Writer out)
QaJGivenReportModel.QaJGivenReportModelBuilder<T,?,?>	toBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

screenshotScale

public final String screenshotScale

testDocumentId

public final String testDocumentId

testDocumentRev

public final String testDocumentRev

specDocumentId

public final String specDocumentId

specDocumentRev

public final String specDocumentRev

planDocumentId

public final String planDocumentId

planDocumentRev

public final String planDocumentRev

traceabilityDocumentId

public final String traceabilityDocumentId

traceabilityDocumentRev

public final String traceabilityDocumentRev

productName

public final String productName

productVersion

public final String productVersion

jgivenReport

public final T jgivenReport

datePattern

public final String datePattern

targetReportFile

public final File targetReportFile

shorten

public final com.samskivert.mustache.Mustache.Lambda shorten

deleteEOL

public final com.samskivert.mustache.Mustache.Lambda deleteEOL

nanoToMillis

public final com.samskivert.mustache.Mustache.Lambda nanoToMillis

asId

public final com.samskivert.mustache.Mustache.Lambda asId

simpleName

public final com.samskivert.mustache.Mustache.Lambda simpleName

translateIntroWord

public final com.samskivert.mustache.Mustache.Lambda translateIntroWord

scaleImage

public final com.samskivert.mustache.Mustache.Lambda scaleImage

isStepFailed

public final com.samskivert.mustache.Mustache.Lambda isStepFailed

isStepPassed

public final com.samskivert.mustache.Mustache.Lambda isStepPassed

Constructor Detail

QaJGivenReportModel

protected QaJGivenReportModel(QaJGivenReportModel.QaJGivenReportModelBuilder<T,?,?> b)

Method Detail

date

public final String date()

scaleImage

public void scaleImage(com.samskivert.mustache.Template.Fragment frag,
                       Writer out)

builder

public static <T> QaJGivenReportModel.QaJGivenReportModelBuilder<T,?,?> builder()

toBuilder

public QaJGivenReportModel.QaJGivenReportModelBuilder<T,?,?> toBuilder()