Package net.ixdarklord.folios.api.client

Record Class FoliosEntry.Page

java.lang.Object

java.lang.Record

net.ixdarklord.folios.api.client.FoliosEntry.Page

Record Components:

marker - a name links can reach it by (entry:<id>#<marker>); null for none

icon - shown before its title: its own ("icon"; FoliosIcon.NONE for "none"), or null for the entry's on its first page and none on the others

Enclosing class:

FoliosEntry

public static record FoliosEntry.Page(FoliosPageElement page, @Nullable String marker, FoliosLock lock, @Nullable FoliosIcon icon)
extends Record

A page of the entry, with what applies to it whatever its kind.

Constructor Summary

Constructors

Constructor	Description
Page(FoliosPageElement page, @Nullable String marker, FoliosLock lock)
Page(FoliosPageElement page, @Nullable String marker, FoliosLock lock, @Nullable FoliosIcon icon)	Creates an instance of a Page 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.
@Nullable FoliosIcon	icon()	Returns the value of the icon record component.
FoliosLock	lock()	Returns the value of the lock record component.
@Nullable String	marker()	Returns the value of the marker record component.
FoliosPageElement	page()	Returns the value of the page 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

Constructor Details

Page

public Page(FoliosPageElement page,
 @Nullable
 @Nullable String marker,
 FoliosLock lock)

Page

public Page(FoliosPageElement page,
 @Nullable
 @Nullable String marker,
 FoliosLock lock,
 @Nullable
 @Nullable FoliosIcon icon)

Creates an instance of a Page record class.

Parameters:

page - the value for the page record component

marker - the value for the marker record component

lock - the value for the lock record component

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

page

public FoliosPageElement page()

Returns the value of the page record component.

Returns:

the value of the page record component

marker

@Nullable
public @Nullable String marker()

Returns the value of the marker record component.

Returns:

the value of the marker record component

lock

public FoliosLock lock()

Returns the value of the lock record component.

Returns:

the value of the lock record component

icon

@Nullable
public @Nullable FoliosIcon icon()

Returns the value of the icon record component.

Returns:

the value of the icon record component