Record Class CaptureGenerationResult

java.lang.Object
java.lang.Record
com.shaft.capture.generate.CaptureGenerationResult
Record Components:
sourcePath - generated Java source
testDataPath - generated JSON test data
reportPath - generation report
enrichmentPreviewPath - optional enrichment preview
report - generation report
public record CaptureGenerationResult(Path sourcePath, Path testDataPath, Path reportPath, Path enrichmentPreviewPath, CaptureGenerationReport report) extends Record
Generated artifact paths and their deterministic report.

  • Constructor Details

    • CaptureGenerationResult

      public CaptureGenerationResult(Path sourcePath, Path testDataPath, Path reportPath, Path enrichmentPreviewPath, CaptureGenerationReport report)
      Creates an instance of a CaptureGenerationResult record class.
      Parameters:
      sourcePath - the value for the sourcePath record component
      testDataPath - the value for the testDataPath record component
      reportPath - the value for the reportPath record component
      enrichmentPreviewPath - the value for the enrichmentPreviewPath record component
      report - the value for the report record component

  • Method Details

    • successful

      public boolean successful()
      Returns whether generation and all requested validations succeeded.
      Returns:
      true for a successful report

    • reviewPath

      public Path reviewPath()
      Returns the deterministic review path beside the generation report.
      Returns:
      review artifact path

    • reviewUiPath

      public Path reviewUiPath()
      Returns the local Capture workbench HTML path beside the review artifact.
      Returns:
      review UI artifact path

    • 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.

    • sourcePath

      public Path sourcePath()
      Returns the value of the sourcePath record component.
      Returns:
      the value of the sourcePath record component

    • testDataPath

      public Path testDataPath()
      Returns the value of the testDataPath record component.
      Returns:
      the value of the testDataPath record component

    • reportPath

      public Path reportPath()
      Returns the value of the reportPath record component.
      Returns:
      the value of the reportPath record component

    • enrichmentPreviewPath

      public Path enrichmentPreviewPath()
      Returns the value of the enrichmentPreviewPath record component.
      Returns:
      the value of the enrichmentPreviewPath record component

    • report

      public CaptureGenerationReport report()
      Returns the value of the report record component.
      Returns:
      the value of the report record component