Package io.codemodder.plugins.llm

Record Class CodeChangingLLMRemediationOutcome

java.lang.Object

java.lang.Record

io.codemodder.plugins.llm.CodeChangingLLMRemediationOutcome

All Implemented Interfaces:

LLMRemediationOutcome

public record CodeChangingLLMRemediationOutcome(String key, String description, String fix)
extends Record
implements LLMRemediationOutcome

Models the parameters for a remediation analysis + actual direction for changing the code.

Constructor Summary

Constructors

Constructor	Description
CodeChangingLLMRemediationOutcome(String key, String description, String fix)	Creates an instance of a CodeChangingLLMRemediationOutcome record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	fix()	Returns the value of the fix record component.
final int	hashCode()	Returns a hash code value for this object.
String	key()	Returns the value of the key record component.
boolean	shouldApplyCodeChanges()	Whether this outcome should lead to a code change.
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

CodeChangingLLMRemediationOutcome

public CodeChangingLLMRemediationOutcome(String key,
 String description,
 String fix)

Creates an instance of a CodeChangingLLMRemediationOutcome record class.

Parameters:

key - the value for the key record component

description - the value for the description record component

fix - the value for the fix record component

Method Details

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

fix

public String fix()

Returns the value of the fix record component.

Specified by:

fix in interface LLMRemediationOutcome

Returns:

the value of the fix record component