Package org.skriptlang.skript.log.runtime

Record Class RuntimeError

java.lang.Object

java.lang.Record

org.skriptlang.skript.log.runtime.RuntimeError

Record Components:

level - The severity (warning or severe)

source - The source of the error

error - The message to display as the error

toHighlight - Optionally, the text within the emitting line to highlight. This should be treated as a regex pattern and will highlight the first match it finds.

public record RuntimeError(Level level, ErrorSource source, String error, @Nullable String toHighlight)
extends Record

Represents a single instance of a runtime error.

Constructor Summary

Constructors

Constructor	Description
RuntimeError(Level level, ErrorSource source, String error, @Nullable String toHighlight)	Creates an instance of a RuntimeError record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	error()	Returns the value of the error record component.
final int	hashCode()	Returns a hash code value for this object.
Level	level()	Returns the value of the level record component.
ErrorSource	source()	Returns the value of the source record component.
@Nullable String	toHighlight()	Returns the value of the toHighlight 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

RuntimeError

public RuntimeError(Level level,
 ErrorSource source,
 String error,
 @Nullable
 @Nullable String toHighlight)

Creates an instance of a RuntimeError record class.

Parameters:

level - the value for the level record component

source - the value for the source record component

error - the value for the error record component

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

level

public Level level()

Returns the value of the level record component.

Returns:

the value of the level record component

source

public ErrorSource source()

Returns the value of the source record component.

Returns:

the value of the source record component

error

public String error()

Returns the value of the error record component.

Returns:

the value of the error record component

toHighlight

@Nullable
public @Nullable String toHighlight()

Returns the value of the toHighlight record component.

Returns:

the value of the toHighlight record component