Record Class SourceRepairs.TextResult

java.lang.Object

java.lang.Record

org.ek9lang.compiler.repair.SourceRepairs.TextResult

Record Components:

text - the repaired text (the input when nothing applied)

corrected - one note per repair made, in order

suggestions - what the writer could do about what still does not parse - nothing applied for it

remaining - the first syntax error still there, or null when the text parses

Enclosing class:

SourceRepairs

public static record SourceRepairs.TextResult(String text, List<String> corrected, List<String> suggestions, SyntaxProbe.SyntaxError remaining)
extends Record

The text layer's outcome.

Constructor Summary

Constructors

Constructor	Description
TextResult(String text, List<String> corrected, List<String> suggestions, SyntaxProbe.SyntaxError remaining)	Creates an instance of a TextResult record class.

Method Summary

Modifier and Type	Method	Description
List<String>	corrected()	Returns the value of the corrected 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.
boolean	parses()
SyntaxProbe.SyntaxError	remaining()	Returns the value of the remaining record component.
List<String>	suggestions()	Returns the value of the suggestions record component.
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

TextResult

public TextResult(String text,
 List<String> corrected,
 List<String> suggestions,
 SyntaxProbe.SyntaxError remaining)

Creates an instance of a TextResult record class.

Parameters:

text - the value for the text record component

corrected - the value for the corrected record component

suggestions - the value for the suggestions record component

remaining - the value for the remaining record component

Method Details

parses

public boolean parses()

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.

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

corrected

public List<String> corrected()

Returns the value of the corrected record component.

Returns:

the value of the corrected record component

suggestions

public List<String> suggestions()

Returns the value of the suggestions record component.

Returns:

the value of the suggestions record component

remaining

public SyntaxProbe.SyntaxError remaining()

Returns the value of the remaining record component.

Returns:

the value of the remaining record component