Package io.codemodder.plugins.llm

Record Class NoActionLLMRemediationOutcome

java.lang.Object
java.lang.Record
io.codemodder.plugins.llm.NoActionLLMRemediationOutcome
All Implemented Interfaces:
LLMRemediationOutcome
public record NoActionLLMRemediationOutcome(String key, String description) extends Record implements LLMRemediationOutcome
Models the parameters for a remediation analysis that results in no code changes.

  • Constructor Details

    • NoActionLLMRemediationOutcome

      public NoActionLLMRemediationOutcome(String key, String description)
      Creates an instance of a NoActionLLMRemediationOutcome record class.
      Parameters:
      key - the value for the key record component
      description - the value for the description record component

  • Method Details

    • fix

      public String fix()
      Description copied from interface: LLMRemediationOutcome
      A description of the fix for cases that match this description.
      Specified by:
      fix in interface LLMRemediationOutcome

    • shouldApplyCodeChanges

      public boolean shouldApplyCodeChanges()
      Description copied from interface: LLMRemediationOutcome
      Whether this outcome should lead to a code change.
      Specified by:
      shouldApplyCodeChanges in interface LLMRemediationOutcome

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

    • key

      public String key()
      Returns the value of the key record component.
      Specified by:
      key in interface LLMRemediationOutcome
      Returns:
      the value of the key record component

    • description

      public String description()
      Returns the value of the description record component.
      Specified by:
      description in interface LLMRemediationOutcome
      Returns:
      the value of the description record component