Module aya.cli.impl

Package org.aya.cli.literate

Record Class HighlightInfo.UserMeta

java.lang.Object

java.lang.Record

org.aya.cli.literate.HighlightInfo.UserMeta

All Implemented Interfaces:

Comparable<HighlightInfo>, HighlightInfo

Enclosing interface:

HighlightInfo

public static record HighlightInfo.UserMeta(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull org.aya.generic.AyaDocile hover)
extends Record
implements HighlightInfo

Usually metavariables

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
UserMeta(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull org.aya.generic.AyaDocile hover)	Creates an instance of a UserMeta 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.
@NotNull org.aya.generic.AyaDocile	hover()	Returns the value of the hover record component.
@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.

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

UserMeta

public UserMeta(@NotNull
 @NotNull org.aya.util.error.SourcePos sourcePos,
 @NotNull
 @NotNull org.aya.generic.AyaDocile hover)

Creates an instance of a UserMeta record class.

Parameters:

sourcePos - the value for the sourcePos record component

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

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

hover

@NotNull
public @NotNull org.aya.generic.AyaDocile hover()

Returns the value of the hover record component.

Returns:

the value of the hover record component