Record Class GuiPageContext

java.lang.Object

java.lang.Record

com.render.api.gui.pagination.GuiPageContext

Record Components:

pageIndex - zero-based page index

pageCount - total page count

templateName - selected page template

public record GuiPageContext(int pageIndex, int pageCount, String templateName)
extends Record

Running header/footer context.

Constructor Summary

Constructors

Constructor	Description
GuiPageContext(int pageIndex, int pageCount, String templateName)	Creates an instance of a GuiPageContext 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.
int	pageCount()	Returns the value of the pageCount record component.
int	pageIndex()	Returns the value of the pageIndex record component.
int	pageNumber()
String	templateName()	Returns the value of the templateName 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

GuiPageContext

public GuiPageContext(int pageIndex,
 int pageCount,
 String templateName)

Creates an instance of a GuiPageContext record class.

Parameters:

pageIndex - the value for the pageIndex record component

pageCount - the value for the pageCount record component

templateName - the value for the templateName record component

Method Details

pageNumber

public int pageNumber()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

pageIndex

public int pageIndex()

Returns the value of the pageIndex record component.

Returns:

the value of the pageIndex record component

pageCount

public int pageCount()

Returns the value of the pageCount record component.

Returns:

the value of the pageCount record component

templateName

public String templateName()

Returns the value of the templateName record component.

Returns:

the value of the templateName record component