Package ai.narrativetrace.gradle

Record Class ClarityScenarioResult

java.lang.Object
java.lang.Record
ai.narrativetrace.gradle.ClarityScenarioResult
public record ClarityScenarioResult(String name, double overallScore, double methodNameScore, double classNameScore, double parameterNameScore, double structuralScore, double cohesionScore, List<ClarityScenarioResult.Issue> issues) extends Record
Gradle-plugin-side view of one clarity scenario result.

INTENT: Represents parsed JSON results without depending on the clarity module's runtime classes.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    ClarityScenarioResult.Issue
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClarityScenarioResult(String name, double overallScore, double methodNameScore, double classNameScore, double parameterNameScore, double structuralScore, double cohesionScore, List<ClarityScenarioResult.Issue> issues)
    Creates an instance of a ClarityScenarioResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    classNameScore()
    Returns the value of the classNameScore record component.
    double
    cohesionScore()
    Returns the value of the cohesionScore record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    List<ClarityScenarioResult.Issue>
    issues()
    Returns the value of the issues record component.
    double
    methodNameScore()
    Returns the value of the methodNameScore record component.
    String
    name()
    Returns the value of the name record component.
    double
    overallScore()
    Returns the value of the overallScore record component.
    double
    parameterNameScore()
    Returns the value of the parameterNameScore record component.
    double
    structuralScore()
    Returns the value of the structuralScore record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ClarityScenarioResult

      public ClarityScenarioResult(String name, double overallScore, double methodNameScore, double classNameScore, double parameterNameScore, double structuralScore, double cohesionScore, List<ClarityScenarioResult.Issue> issues)
      Creates an instance of a ClarityScenarioResult record class.
      Parameters:
      name - the value for the name record component
      overallScore - the value for the overallScore record component
      methodNameScore - the value for the methodNameScore record component
      classNameScore - the value for the classNameScore record component
      parameterNameScore - the value for the parameterNameScore record component
      structuralScore - the value for the structuralScore record component
      cohesionScore - the value for the cohesionScore record component
      issues - the value for the issues 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • name

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

    • overallScore

      public double overallScore()
      Returns the value of the overallScore record component.
      Returns:
      the value of the overallScore record component

    • methodNameScore

      public double methodNameScore()
      Returns the value of the methodNameScore record component.
      Returns:
      the value of the methodNameScore record component

    • classNameScore

      public double classNameScore()
      Returns the value of the classNameScore record component.
      Returns:
      the value of the classNameScore record component

    • parameterNameScore

      public double parameterNameScore()
      Returns the value of the parameterNameScore record component.
      Returns:
      the value of the parameterNameScore record component

    • structuralScore

      public double structuralScore()
      Returns the value of the structuralScore record component.
      Returns:
      the value of the structuralScore record component

    • cohesionScore

      public double cohesionScore()
      Returns the value of the cohesionScore record component.
      Returns:
      the value of the cohesionScore record component

    • issues

      public List<ClarityScenarioResult.Issue> issues()
      Returns the value of the issues record component.
      Returns:
      the value of the issues record component