Module aya.cli.impl

Package org.aya.cli.literate

Record Class HighlightInfo.Def

java.lang.Object

java.lang.Record

org.aya.cli.literate.HighlightInfo.Def

All Implemented Interfaces:

Comparable<HighlightInfo>, HighlightInfo

Enclosing interface:

HighlightInfo

public static record HighlightInfo.Def(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull org.aya.pretty.doc.Link target, @NotNull HighlightInfo.DefKind kind, @Nullable org.aya.generic.AyaDocile type)
extends Record
implements HighlightInfo

A definition of a symbol

Nested Class Summary

Nested classes/interfaces inherited from interface org.aya.cli.literate.HighlightInfo

HighlightInfo.Def, HighlightInfo.DefKind, HighlightInfo.Err, HighlightInfo.Lit, HighlightInfo.LitKind, HighlightInfo.Ref, HighlightInfo.UserMeta

Constructor Summary

Constructors

Constructor	Description
Def(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull org.aya.pretty.doc.Link target, @NotNull HighlightInfo.DefKind kind, @Nullable org.aya.generic.AyaDocile type)	Creates an instance of a Def record class.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
@NotNull HighlightInfo.DefKind	kind()	Returns the value of the kind record component.
@NotNull org.aya.util.error.SourcePos	sourcePos()	Returns the value of the sourcePos record component.
@NotNull org.aya.pretty.doc.Link	target()	Returns the value of the target record component.
final String	toString()	Returns a string representation of this record class.
@Nullable org.aya.generic.AyaDocile	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aya.cli.literate.HighlightInfo

compareTo

Constructor Details

Def

public Def(@NotNull
 @NotNull org.aya.util.error.SourcePos sourcePos,
 @NotNull
 @NotNull org.aya.pretty.doc.Link target,
 @NotNull
 @NotNull HighlightInfo.DefKind kind,
 @Nullable
 @Nullable org.aya.generic.AyaDocile type)

Creates an instance of a Def record class.

Parameters:

sourcePos - the value for the sourcePos record component

target - the value for the target record component

kind - the value for the kind record component

type - the value for the type record component

Method Details

equals

public 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.

hashCode

public 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

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

sourcePos

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

Returns the value of the sourcePos record component.

Specified by:

sourcePos in interface HighlightInfo

Returns:

the value of the sourcePos record component

target

@NotNull
public @NotNull org.aya.pretty.doc.Link target()

Returns the value of the target record component.

Returns:

the value of the target record component

kind

@NotNull
public @NotNull HighlightInfo.DefKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

type

@Nullable
public @Nullable org.aya.generic.AyaDocile type()

Returns the value of the type record component.

Returns:

the value of the type record component