Module aya.base

Package org.aya.concrete.remark

Record Class Literate.Link

java.lang.Object

java.lang.Record

org.aya.concrete.remark.Literate.Link

All Implemented Interfaces:

Literate, org.aya.pretty.doc.Docile

Enclosing interface:

Literate

public static record Literate.Link(@NotNull String href, @Nullable String hover, @NotNull kala.collection.immutable.ImmutableSeq<Literate> children)
extends Record
implements Literate

Nested Class Summary

Nested classes/interfaces inherited from interface org.aya.concrete.remark.Literate

Literate.Code, Literate.CodeBlock, Literate.Err, Literate.Link, Literate.Many, Literate.Raw, Literate.Unsupported

Constructor Summary

Constructors

Constructor	Description
Link(@NotNull String href, @Nullable String hover, @NotNull kala.collection.immutable.ImmutableSeq<Literate> children)	Creates an instance of a Link record class.

Method Summary

Modifier and Type	Method	Description
@NotNull kala.collection.immutable.ImmutableSeq<Literate>	children()	Returns the value of the children record component.
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.
@Nullable String	hover()	Returns the value of the hover record component.
@NotNull String	href()	Returns the value of the href record component.
@NotNull org.aya.pretty.doc.Doc	toDoc()
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

Link

public Link(@NotNull
 @NotNull String href,
 @Nullable
 @Nullable String hover,
 @NotNull
 @NotNull kala.collection.immutable.ImmutableSeq<Literate> children)

Creates an instance of a Link record class.

Parameters:

href - the value for the href record component

hover - the value for the hover record component

children - the value for the children record component

Method Details

toDoc

@NotNull
public @NotNull org.aya.pretty.doc.Doc toDoc()

Specified by:

toDoc in interface org.aya.pretty.doc.Docile

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.

href

@NotNull
public @NotNull String href()

Returns the value of the href record component.

Returns:

the value of the href record component

hover

@Nullable
public @Nullable String hover()

Returns the value of the hover record component.

Returns:

the value of the hover record component

children

@NotNull
public @NotNull kala.collection.immutable.ImmutableSeq<Literate> children()

Returns the value of the children record component.

Returns:

the value of the children record component