Record Class ApiCaptureGenerationResult

java.lang.Object
java.lang.Record
com.shaft.capture.generate.api.ApiCaptureGenerationResult
Record Components:
sourcePath - generated source path, or null if generation failed before a path could be determined
testDataDirectory - directory holding generated schema/golden-file artifacts, or null if generation failed before one could be determined
reportPath - generation report path
report - deterministic generation report
public record ApiCaptureGenerationResult(Path sourcePath, Path testDataDirectory, Path reportPath, CaptureGenerationReport report) extends Record
Artifacts and report produced by ApiCaptureGenerator.

  • Constructor Details

    • ApiCaptureGenerationResult

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

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

    • sourcePath

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

    • testDataDirectory

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

    • reportPath

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

    • report

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