Module com.darkcollective.relix.symbol

Package com.darkcollective.relix.symbol

Record Class SymbolError

java.lang.Object

java.lang.Record

com.darkcollective.relix.symbol.SymbolError

Record Components:

kind - the error classification

namespace - the namespace in which the conflict occurred

symbolName - the name (declared form) of the symbol being registered

message - a human-readable description of the problem

public record SymbolError(SymbolError.Kind kind, String namespace, String symbolName, String message)
extends Record

A non-fatal diagnostic produced during symbol registration.

Errors are collected rather than thrown so that all conflicts in a registration batch can be reported at once. Callers inspect RegistrationResult.errors() and decide how to surface them.

Two kinds exist:

• SymbolError.Kind.SHADOW_FORBIDDEN — registration was rejected because the existing symbol's ShadowPolicy is ShadowPolicy.FORBIDDEN. The table is unchanged.
• SymbolError.Kind.SHADOW_WARNING — registration succeeded but the new symbol replaced an existing one whose policy is ShadowPolicy.WARN_AND_PERMIT. The table now holds the new symbol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SymbolError.Kind	Classification of symbol registration errors.

Constructor Summary

Constructors

Constructor	Description
SymbolError(SymbolError.Kind kind, String namespace, String symbolName, String message)	Creates an instance of a SymbolError record class.

Method Summary

Modifier and Type	Method	Description
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.
SymbolError.Kind	kind()	Returns the value of the kind record component.
String	message()	Returns the value of the message record component.
String	namespace()	Returns the value of the namespace record component.
String	symbolName()	Returns the value of the symbolName 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

SymbolError

public SymbolError(SymbolError.Kind kind,
 String namespace,
 String symbolName,
 String message)

Creates an instance of a SymbolError record class.

Parameters:

kind - the value for the kind record component

namespace - the value for the namespace record component

symbolName - the value for the symbolName record component

message - the value for the message 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. 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.

kind

public SymbolError.Kind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

namespace

public String namespace()

Returns the value of the namespace record component.

Returns:

the value of the namespace record component

symbolName

public String symbolName()

Returns the value of the symbolName record component.

Returns:

the value of the symbolName record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component