Record Class FormatterResult

java.lang.Object

java.lang.Record

org.ek9lang.compiler.formatter.FormatterResult

public record FormatterResult(FormatterResult.FormatterState state, String output, List<String> corrections, List<String> errors)
extends Record

Result of a formatting operation. Contains the formatted output (if successful), state, and any error information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FormatterResult.FormatterState	The state of the formatter after processing.

Constructor Summary

Constructors

Constructor	Description
FormatterResult(FormatterResult.FormatterState state, String output, List<String> corrections, List<String> errors)	Creates an instance of a FormatterResult record class.

Method Summary

Modifier and Type	Method	Description
List<String>	corrections()	Returns the value of the corrections record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	errors()	Returns the value of the errors record component.
static FormatterResult	failure(List<String> errors)	Create a failed formatting result.
final int	hashCode()	Returns a hash code value for this object.
boolean	isSuccess()	Check if the formatting was successful.
String	output()	Returns the value of the output record component.
FormatterResult.FormatterState	state()	Returns the value of the state record component.
static FormatterResult	success(String output)	Create a successful formatting result.
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

FormatterResult

public FormatterResult(FormatterResult.FormatterState state,
 String output,
 List<String> corrections,
 List<String> errors)

Creates an instance of a FormatterResult record class.

Parameters:

state - the value for the state record component

output - the value for the output record component

corrections - the value for the corrections record component

errors - the value for the errors record component

Method Details

success

public static FormatterResult success(String output)

Create a successful formatting result.

failure

public static FormatterResult failure(List<String> errors)

Create a failed formatting result.

isSuccess

public boolean isSuccess()

Check if the formatting was successful.

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.

state

public FormatterResult.FormatterState state()

Returns the value of the state record component.

Returns:

the value of the state record component

output

public String output()

Returns the value of the output record component.

Returns:

the value of the output record component

corrections

public List<String> corrections()

Returns the value of the corrections record component.

Returns:

the value of the corrections record component

errors

public List<String> errors()

Returns the value of the errors record component.

Returns:

the value of the errors record component