Record Class CaptureGenerationReport

java.lang.Object

java.lang.Record

com.shaft.capture.generate.CaptureGenerationReport

Record Components:

schemaVersion - report schema version

sessionId - source Capture session

status - generation status

sourcePath - output-root-relative source path

testDataPath - output-root-relative test-data path

readiness - live capture readiness state

readinessWarnings - live capture readiness warnings

locatorDecisions - selected locator rationale

unsupportedEvents - unsupported event diagnostics

flakySteps - replay-risk diagnostics

fallbackLocators - available fallback locator diagnostics

controlFlowSuggestions - deterministic control-flow suggestions

requiredUserInputs - unresolved external inputs

warnings - safe warnings

compilation - compilation result

replay - replay result

enrichment - enrichment result

openApiCoverage - OpenAPI coverage cross-report, or null when no spec was provided

public record CaptureGenerationReport(String schemaVersion, String sessionId, CaptureGenerationReport.Status status, String sourcePath, String testDataPath, CaptureReadiness.State readiness, List<String> readinessWarnings, List<CaptureGenerationReport.LocatorDecision> locatorDecisions, List<String> unsupportedEvents, List<String> flakySteps, List<String> fallbackLocators, List<CaptureGenerationReport.ControlFlowSuggestion> controlFlowSuggestions, List<String> requiredUserInputs, List<String> warnings, CaptureGenerationReport.Validation compilation, CaptureGenerationReport.Validation replay, CaptureGenerationReport.Enrichment enrichment, CaptureGenerationReport.OpenApiCoverage openApiCoverage)
extends Record

Deterministic generation, locator-selection, compilation, and replay report.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CaptureGenerationReport.ControlFlowKind	Deterministic control-flow suggestion kind.
static final record	CaptureGenerationReport.ControlFlowSuggestion	One deterministic control-flow suggestion.
static final record	CaptureGenerationReport.Enrichment	Optional AI enrichment state.
static final record	CaptureGenerationReport.LocatorDecision	One explainable locator choice.
static final record	CaptureGenerationReport.OpenApiCoverage	Deterministic OpenAPI coverage cross-report (see OpenApiCoverageReporter in com.shaft.capture.generate.api.internal, which this record mirrors so the report can live in this module without an API-codegen-specific dependency).
static enum	CaptureGenerationReport.Status	Generation status.
static final record	CaptureGenerationReport.Validation	Compile or replay result.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_SCHEMA_VERSION

Constructor Summary

Constructors

Constructor	Description
CaptureGenerationReport(String schemaVersion, String sessionId, CaptureGenerationReport.Status status, String sourcePath, String testDataPath, CaptureReadiness.State readiness, List<String> readinessWarnings, List<CaptureGenerationReport.LocatorDecision> locatorDecisions, List<String> unsupportedEvents, List<String> flakySteps, List<String> fallbackLocators, List<CaptureGenerationReport.ControlFlowSuggestion> controlFlowSuggestions, List<String> requiredUserInputs, List<String> warnings, CaptureGenerationReport.Validation compilation, CaptureGenerationReport.Validation replay, CaptureGenerationReport.Enrichment enrichment)	Compatibility constructor for callers compiled before OpenAPI coverage was added.
CaptureGenerationReport(String schemaVersion, String sessionId, CaptureGenerationReport.Status status, String sourcePath, String testDataPath, CaptureReadiness.State readiness, List<String> readinessWarnings, List<CaptureGenerationReport.LocatorDecision> locatorDecisions, List<String> unsupportedEvents, List<String> flakySteps, List<String> fallbackLocators, List<CaptureGenerationReport.ControlFlowSuggestion> controlFlowSuggestions, List<String> requiredUserInputs, List<String> warnings, CaptureGenerationReport.Validation compilation, CaptureGenerationReport.Validation replay, CaptureGenerationReport.Enrichment enrichment, CaptureGenerationReport.OpenApiCoverage openApiCoverage)	Creates an immutable report.
CaptureGenerationReport(String schemaVersion, String sessionId, CaptureGenerationReport.Status status, String sourcePath, String testDataPath, CaptureReadiness.State readiness, List<String> readinessWarnings, List<CaptureGenerationReport.LocatorDecision> locatorDecisions, List<String> unsupportedEvents, List<String> flakySteps, List<String> fallbackLocators, List<String> requiredUserInputs, List<String> warnings, CaptureGenerationReport.Validation compilation, CaptureGenerationReport.Validation replay, CaptureGenerationReport.Enrichment enrichment)	Compatibility constructor for callers compiled before control-flow suggestions were added.
CaptureGenerationReport(String schemaVersion, String sessionId, CaptureGenerationReport.Status status, String sourcePath, String testDataPath, List<CaptureGenerationReport.LocatorDecision> locatorDecisions, List<String> unsupportedEvents, List<String> flakySteps, List<String> fallbackLocators, List<String> requiredUserInputs, List<String> warnings, CaptureGenerationReport.Validation compilation, CaptureGenerationReport.Validation replay, CaptureGenerationReport.Enrichment enrichment)	Compatibility constructor for callers compiled before readiness was added.

Method Summary

Modifier and Type	Method	Description
CaptureGenerationReport.Validation	compilation()	Returns the value of the compilation record component.
List<CaptureGenerationReport.ControlFlowSuggestion>	controlFlowSuggestions()	Returns the value of the controlFlowSuggestions record component.
CaptureGenerationReport.Enrichment	enrichment()	Returns the value of the enrichment record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	fallbackLocators()	Returns the value of the fallbackLocators record component.
List<String>	flakySteps()	Returns the value of the flakySteps record component.
final int	hashCode()	Returns a hash code value for this object.
List<CaptureGenerationReport.LocatorDecision>	locatorDecisions()	Returns the value of the locatorDecisions record component.
CaptureGenerationReport.OpenApiCoverage	openApiCoverage()	Returns the value of the openApiCoverage record component.
CaptureReadiness.State	readiness()	Returns the value of the readiness record component.
List<String>	readinessWarnings()	Returns the value of the readinessWarnings record component.
CaptureGenerationReport.Validation	replay()	Returns the value of the replay record component.
List<String>	requiredUserInputs()	Returns the value of the requiredUserInputs record component.
String	schemaVersion()	Returns the value of the schemaVersion record component.
String	sessionId()	Returns the value of the sessionId record component.
String	sourcePath()	Returns the value of the sourcePath record component.
CaptureGenerationReport.Status	status()	Returns the value of the status record component.
String	testDataPath()	Returns the value of the testDataPath record component.
final String	toString()	Returns a string representation of this record class.
List<String>	unsupportedEvents()	Returns the value of the unsupportedEvents record component.
List<String>	warnings()	Returns the value of the warnings record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

CURRENT_SCHEMA_VERSION

public static final String CURRENT_SCHEMA_VERSION

See Also:

• Constant Field Values

Constructor Details

CaptureGenerationReport

public CaptureGenerationReport(String schemaVersion,
 String sessionId,
 CaptureGenerationReport.Status status,
 String sourcePath,
 String testDataPath,
 CaptureReadiness.State readiness,
 List<String> readinessWarnings,
 List<CaptureGenerationReport.LocatorDecision> locatorDecisions,
 List<String> unsupportedEvents,
 List<String> flakySteps,
 List<String> fallbackLocators,
 List<CaptureGenerationReport.ControlFlowSuggestion> controlFlowSuggestions,
 List<String> requiredUserInputs,
 List<String> warnings,
 CaptureGenerationReport.Validation compilation,
 CaptureGenerationReport.Validation replay,
 CaptureGenerationReport.Enrichment enrichment,
 CaptureGenerationReport.OpenApiCoverage openApiCoverage)

Creates an immutable report.

CaptureGenerationReport

public CaptureGenerationReport(String schemaVersion,
 String sessionId,
 CaptureGenerationReport.Status status,
 String sourcePath,
 String testDataPath,
 CaptureReadiness.State readiness,
 List<String> readinessWarnings,
 List<CaptureGenerationReport.LocatorDecision> locatorDecisions,
 List<String> unsupportedEvents,
 List<String> flakySteps,
 List<String> fallbackLocators,
 List<CaptureGenerationReport.ControlFlowSuggestion> controlFlowSuggestions,
 List<String> requiredUserInputs,
 List<String> warnings,
 CaptureGenerationReport.Validation compilation,
 CaptureGenerationReport.Validation replay,
 CaptureGenerationReport.Enrichment enrichment)

Compatibility constructor for callers compiled before OpenAPI coverage was added.

Parameters:

schemaVersion - report schema version

sessionId - source Capture session

status - generation status

sourcePath - output-root-relative source path

testDataPath - output-root-relative test-data path

readiness - live capture readiness state

readinessWarnings - live capture readiness warnings

locatorDecisions - selected locator rationale

unsupportedEvents - unsupported event diagnostics

flakySteps - replay-risk diagnostics

fallbackLocators - available fallback locator diagnostics

controlFlowSuggestions - deterministic control-flow suggestions

requiredUserInputs - unresolved external inputs

warnings - safe warnings

compilation - compilation result

replay - replay result

enrichment - enrichment result

CaptureGenerationReport

public CaptureGenerationReport(String schemaVersion,
 String sessionId,
 CaptureGenerationReport.Status status,
 String sourcePath,
 String testDataPath,
 CaptureReadiness.State readiness,
 List<String> readinessWarnings,
 List<CaptureGenerationReport.LocatorDecision> locatorDecisions,
 List<String> unsupportedEvents,
 List<String> flakySteps,
 List<String> fallbackLocators,
 List<String> requiredUserInputs,
 List<String> warnings,
 CaptureGenerationReport.Validation compilation,
 CaptureGenerationReport.Validation replay,
 CaptureGenerationReport.Enrichment enrichment)

Compatibility constructor for callers compiled before control-flow suggestions were added.

Parameters:

schemaVersion - report schema version

sessionId - source Capture session

status - generation status

sourcePath - output-root-relative source path

testDataPath - output-root-relative test-data path

readiness - live capture readiness state

readinessWarnings - live capture readiness warnings

locatorDecisions - selected locator rationale

unsupportedEvents - unsupported event diagnostics

flakySteps - replay-risk diagnostics

fallbackLocators - available fallback locator diagnostics

requiredUserInputs - unresolved external inputs

warnings - safe warnings

compilation - compilation result

replay - replay result

enrichment - enrichment result

CaptureGenerationReport

public CaptureGenerationReport(String schemaVersion,
 String sessionId,
 CaptureGenerationReport.Status status,
 String sourcePath,
 String testDataPath,
 List<CaptureGenerationReport.LocatorDecision> locatorDecisions,
 List<String> unsupportedEvents,
 List<String> flakySteps,
 List<String> fallbackLocators,
 List<String> requiredUserInputs,
 List<String> warnings,
 CaptureGenerationReport.Validation compilation,
 CaptureGenerationReport.Validation replay,
 CaptureGenerationReport.Enrichment enrichment)

Compatibility constructor for callers compiled before readiness was added.

Parameters:

schemaVersion - report schema version

sessionId - source Capture session

status - generation status

sourcePath - output-root-relative source path

testDataPath - output-root-relative test-data path

locatorDecisions - selected locator rationale

unsupportedEvents - unsupported event diagnostics

flakySteps - replay-risk diagnostics

fallbackLocators - available fallback locator diagnostics

requiredUserInputs - unresolved external inputs

warnings - safe warnings

compilation - compilation result

replay - replay result

enrichment - enrichment result

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

schemaVersion

public String schemaVersion()

Returns the value of the schemaVersion record component.

Returns:

the value of the schemaVersion record component

sessionId

public String sessionId()

Returns the value of the sessionId record component.

Returns:

the value of the sessionId record component

status

public CaptureGenerationReport.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

sourcePath

public String sourcePath()

Returns the value of the sourcePath record component.

Returns:

the value of the sourcePath record component

testDataPath

public String testDataPath()

Returns the value of the testDataPath record component.

Returns:

the value of the testDataPath record component

readiness

public CaptureReadiness.State readiness()

Returns the value of the readiness record component.

Returns:

the value of the readiness record component

readinessWarnings

public List<String> readinessWarnings()

Returns the value of the readinessWarnings record component.

Returns:

the value of the readinessWarnings record component

locatorDecisions

public List<CaptureGenerationReport.LocatorDecision> locatorDecisions()

Returns the value of the locatorDecisions record component.

Returns:

the value of the locatorDecisions record component

unsupportedEvents

public List<String> unsupportedEvents()

Returns the value of the unsupportedEvents record component.

Returns:

the value of the unsupportedEvents record component

flakySteps

public List<String> flakySteps()

Returns the value of the flakySteps record component.

Returns:

the value of the flakySteps record component

fallbackLocators

public List<String> fallbackLocators()

Returns the value of the fallbackLocators record component.

Returns:

the value of the fallbackLocators record component

controlFlowSuggestions

public List<CaptureGenerationReport.ControlFlowSuggestion> controlFlowSuggestions()

Returns the value of the controlFlowSuggestions record component.

Returns:

the value of the controlFlowSuggestions record component

requiredUserInputs

public List<String> requiredUserInputs()

Returns the value of the requiredUserInputs record component.

Returns:

the value of the requiredUserInputs record component

warnings

public List<String> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component

compilation

public CaptureGenerationReport.Validation compilation()

Returns the value of the compilation record component.

Returns:

the value of the compilation record component

replay

public CaptureGenerationReport.Validation replay()

Returns the value of the replay record component.

Returns:

the value of the replay record component

enrichment

public CaptureGenerationReport.Enrichment enrichment()

Returns the value of the enrichment record component.

Returns:

the value of the enrichment record component

openApiCoverage

public CaptureGenerationReport.OpenApiCoverage openApiCoverage()

Returns the value of the openApiCoverage record component.

Returns:

the value of the openApiCoverage record component