Module aya.cli.impl

Package org.aya.cli.literate

Record Class HighlightInfo

java.lang.Object

java.lang.Record

org.aya.cli.literate.HighlightInfo

All Implemented Interfaces:

Comparable<HighlightInfo>

public record HighlightInfo(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull HighlightInfo.HighlightSymbol type)
extends Record
implements Comparable<HighlightInfo>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HighlightInfo.DefKind
static interface	HighlightInfo.HighlightSymbol
static enum	HighlightInfo.LitKind
static final record	HighlightInfo.SymDef	A definition of a symbol
static final record	HighlightInfo.SymError	An error element
static final record	HighlightInfo.SymLit	A literal
static final record	HighlightInfo.SymRef	A reference to a symbol

Constructor Summary

Constructors

Constructor	Description
HighlightInfo(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull HighlightInfo.HighlightSymbol type)	Creates an instance of a HighlightInfo record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NotNull HighlightInfo o)
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.
@NotNull org.aya.util.error.SourcePos	sourcePos()	Returns the value of the sourcePos record component.
final String	toString()	Returns a string representation of this record class.
@NotNull HighlightInfo.HighlightSymbol	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightInfo

public HighlightInfo(@NotNull
 @NotNull org.aya.util.error.SourcePos sourcePos,
 @NotNull
 @NotNull HighlightInfo.HighlightSymbol type)

Creates an instance of a HighlightInfo record class.

Parameters:

sourcePos - the value for the sourcePos record component

type - the value for the type record component

Method Details

compareTo

public int compareTo(@NotNull
 @NotNull HighlightInfo o)

Specified by:

compareTo in interface Comparable<HighlightInfo>

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.

sourcePos

@NotNull
public @NotNull org.aya.util.error.SourcePos sourcePos()

Returns the value of the sourcePos record component.

Returns:

the value of the sourcePos record component

type

@NotNull
public @NotNull HighlightInfo.HighlightSymbol type()

Returns the value of the type record component.

Returns:

the value of the type record component