Record Class FoliosSession.EntryPages

java.lang.Object

java.lang.Record

net.ixdarklord.folios.internal.client.FoliosSession.EntryPages

Enclosing class:

FoliosSession

public static record FoliosSession.EntryPages(List<FoliosPageElement.Laid> pages, Map<String,Integer> markers, int[] starts)
extends Record

An entry's pages, ready to draw: markers and the pages of its JSON point into them.

Constructor Summary

Constructors

Constructor	Description
EntryPages(List<FoliosPageElement.Laid> pages, Map<String,Integer> markers, int[] starts)	Creates an instance of a EntryPages 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.
Map<String,Integer>	markers()	Returns the value of the markers record component.
List<FoliosPageElement.Laid>	pages()	Returns the value of the pages record component.
int	source(int laid)	Which page of the entry's JSON a laid page came from.
int	start(int page)	Where a page of the entry's JSON begins among the laid pages.
int[]	starts()	Returns the value of the starts 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

Constructor Details

EntryPages

public EntryPages(List<FoliosPageElement.Laid> pages,
 Map<String,Integer> markers,
 int[] starts)

Creates an instance of a EntryPages record class.

Parameters:

pages - the value for the pages record component

markers - the value for the markers record component

starts - the value for the starts record component

Method Details

start

public int start(int page)

Where a page of the entry's JSON begins among the laid pages.

source

public int source(int laid)

Which page of the entry's JSON a laid page came from.

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.

pages

public List<FoliosPageElement.Laid> pages()

Returns the value of the pages record component.

Returns:

the value of the pages record component

markers

public Map<String,Integer> markers()

Returns the value of the markers record component.

Returns:

the value of the markers record component

starts

public int[] starts()

Returns the value of the starts record component.

Returns:

the value of the starts record component