Module aya.pretty

Package org.aya.pretty.doc

Record Class Doc.HyperLinked

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Doc.HyperLinked

Record Components:

href - The id of jump target when clicked.

id - The id of the doc itself.

All Implemented Interfaces:

Doc, Docile

Enclosing interface:

Doc

public static record Doc.HyperLinked(@NotNull Doc doc, @NotNull Link href, @Nullable Link id, @Nullable String hover)
extends Record
implements Doc

A clickable text line without '\n'.

Nested Class Summary

Nested classes/interfaces inherited from interface org.aya.pretty.doc.Doc

Doc.Cat, Doc.CodeBlock, Doc.Column, Doc.Empty, Doc.EscapedText, Doc.FlatAlt, Doc.HyperLinked, Doc.Image, Doc.InlineCode, Doc.Line, Doc.List, Doc.Nest, Doc.Nesting, Doc.PageWidth, Doc.PlainText, Doc.SpecialSymbol, Doc.Styled, Doc.Union

Field Summary

Fields inherited from interface org.aya.pretty.doc.Doc

ALT_WS, COMMA, ONE_WS

Constructor Summary

Constructors

Constructor	Description
HyperLinked(@NotNull Doc doc, @NotNull Link href, @Nullable Link id, @Nullable String hover)	Creates an instance of a HyperLinked record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Doc	doc()	Returns the value of the doc 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 Link	href()	Returns the value of the href record component.
@Nullable Link	id()	Returns the value of the id 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.pretty.doc.Doc

asSeq, commonRender, debugRender, isEmpty, isNotEmpty, render, renderToAyaMd, renderToHtml, renderToHtml, renderToMd, renderToString, renderToString, renderToTerminal, renderToTerminal, renderToTeX, toDoc

Constructor Details

HyperLinked

public HyperLinked(@NotNull
 @NotNull Doc doc,
 @NotNull
 @NotNull Link href,
 @Nullable
 @Nullable Link id,
 @Nullable
 @Nullable String hover)

Creates an instance of a HyperLinked record class.

Parameters:

doc - the value for the doc record component

href - the value for the href record component

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

doc

@NotNull
public @NotNull Doc doc()

Returns the value of the doc record component.

Returns:

the value of the doc record component

href

@NotNull
public @NotNull Link href()

Returns the value of the href record component.

Returns:

the value of the href record component

id

@Nullable
public @Nullable Link id()

Returns the value of the id record component.

Returns:

the value of the id record component

hover

@Nullable
public @Nullable String hover()

Returns the value of the hover record component.

Returns:

the value of the hover record component