Package com.arc_e_tect.gradle.apionly.transcriberj.core

Class GenerationReport

java.lang.Object

com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

public final class GenerationReport
extends Object

What a generation run could not do in full, and what the specification could do about it: the end-of-run report D14 asks for.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GenerationReport.Degraded	A generated method that throws instead of doing its work.
static final record	GenerationReport.Recommendation	Something the specification could do better, and how.

Constructor Summary

Constructors

Constructor	Description
GenerationReport()	Creates an empty report.

Method Summary

Modifier and Type	Method	Description
List<GenerationReport.Degraded>	degraded()	Every degraded method.
void	note(String note)	Records something worth saying about this generation that is not a problem.
List<String>	notes()	What this generation had to say about itself.
List<GenerationReport.Recommendation>	recommendations()	Every recommendation.
String	render(String contract, String version)	The report as text, for a file and a build log.
List<Finding>	undecided()	Every construct no generation rule has been decided for.
List<String>	warnings()	Everything about the contract's design worth a second look.

Methods inherited from class java.lang.Object

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

Constructor Details

GenerationReport

public GenerationReport()

Creates an empty report.

Method Details

degraded

public List<GenerationReport.Degraded> degraded()

Every degraded method.

Returns:

the entries, in the order they were written

recommendations

public List<GenerationReport.Recommendation> recommendations()

Every recommendation.

Returns:

the entries, in the order they were made

undecided

public List<Finding> undecided()

Every construct no generation rule has been decided for.

Returns:

the findings, in contract order

warnings

public List<String> warnings()

Everything about the contract's design worth a second look.

Returns:

the warnings, in the order they were found

note

public void note(String note)

Records something worth saying about this generation that is not a problem.

Parameters:

note - the note

notes

public List<String> notes()

What this generation had to say about itself.

Returns:

the notes, in the order they were made

render

public String render(String contract,
 String version)

The report as text, for a file and a build log.

Parameters:

contract - the contract's name

version - the contract's version

Returns:

the text