Record Class LinksPageElement

java.lang.Object

java.lang.Record

net.ixdarklord.folios.internal.client.page.LinksPageElement

All Implemented Interfaces:

FoliosPageElement

public record LinksPageElement(List<LinksPageElement.Link> links, Optional<String> title, String text)
extends Record
implements FoliosPageElement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LinksPageElement.Link	An entry to link to (its id, with an optional #marker), and the words shown for it; empty for its name.

Nested classes/interfaces inherited from interface FoliosPageElement

FoliosPageElement.Laid, FoliosPageElement.Part, FoliosPageElement.SpreadHalf

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<LinksPageElement>	CODEC

Constructor Summary

Constructors

Constructor	Description
LinksPageElement(List<LinksPageElement.Link> links, Optional<String> title, String text)	Creates an instance of a LinksPageElement 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.
List<FoliosPageElement.Laid>	lay(FoliosLayout layout)	Sets the page out: one or more pages, each drawn on its own.
List<LinksPageElement.Link>	links()	Returns the value of the links record component.
String	searchText()	Words of the page a search should find it by.
String	text()	Returns the value of the text record component.
Optional<String>	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface FoliosPageElement

items, objectives, spread

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<LinksPageElement> CODEC

Constructor Details

LinksPageElement

public LinksPageElement(List<LinksPageElement.Link> links,
 Optional<String> title,
 String text)

Creates an instance of a LinksPageElement record class.

Parameters:

links - the value for the links record component

title - the value for the title record component

text - the value for the text record component

Method Details

lay

public List<FoliosPageElement.Laid> lay(FoliosLayout layout)

Description copied from interface: FoliosPageElement

Sets the page out: one or more pages, each drawn on its own.

Specified by:

lay in interface FoliosPageElement

searchText

public String searchText()

Description copied from interface: FoliosPageElement

Words of the page a search should find it by.

Specified by:

searchText in interface FoliosPageElement

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.

links

public List<LinksPageElement.Link> links()

Returns the value of the links record component.

Returns:

the value of the links record component

title

public Optional<String> title()

Returns the value of the title record component.

Returns:

the value of the title record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component