Record Class GoalReportSpec

java.lang.Object
java.lang.Record
network.ike.plugin.support.GoalReportSpec
Record Components:
goal - the goal that produced this report
projectRoot - directory the report file is written into (alongside the invoking pom.xml)
content - the Markdown report body
public record GoalReportSpec(GoalRef goal, Path projectRoot, String content) extends Record
The report a goal produces — which goal it is, where its report file lands, and the Markdown body.

Returned by AbstractGoalMojo.runGoal(); the base class writes it via GoalReport. Making the report a required return value — rather than an optional writeReport(...) call a goal author can forget — means a goal cannot compile without producing one. That is the structural fix for the missing-report bug class (IKE-Network/ike-issues#413, motivated by #407).

  • Constructor Details

    • GoalReportSpec

      public GoalReportSpec(GoalRef goal, Path projectRoot, String content)
      Creates an instance of a GoalReportSpec record class.
      Parameters:
      goal - the value for the goal record component
      projectRoot - the value for the projectRoot record component
      content - the value for the content 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.

    • goal

      public GoalRef goal()
      Returns the value of the goal record component.
      Returns:
      the value of the goal record component

    • projectRoot

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

    • content

      public String content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component