Record Class GuidePageRequest

java.lang.Object

java.lang.Record

ke.ric.api.guide.GuidePageRequest

public record GuidePageRequest(int pageIndex, String entryRoute, Map<String,String> state)
extends Record

Requested list window and an optional displayed entry route to keep clicks stable as lists change.

Constructor Summary

Constructors

Constructor	Description
GuidePageRequest(int pageIndex)
GuidePageRequest(int pageIndex, String entryRoute)
GuidePageRequest(int pageIndex, String entryRoute, Map<String,String> state)	Creates an instance of a GuidePageRequest record class.

Method Summary

Modifier and Type	Method	Description
String	entryRoute()	Returns the value of the entryRoute 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.
int	pageIndex()	Returns the value of the pageIndex record component.
Map<String,String>	state()	Returns the value of the state record component.
final String	toString()	Returns a string representation of this record class.
GuidePageRequest	withState(Map<String,String> state)

Methods inherited from class Object

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

Constructor Details

GuidePageRequest

public GuidePageRequest(int pageIndex,
 String entryRoute)

GuidePageRequest

public GuidePageRequest(int pageIndex)

GuidePageRequest

public GuidePageRequest(int pageIndex,
 String entryRoute,
 Map<String,String> state)

Creates an instance of a GuidePageRequest record class.

Parameters:

pageIndex - the value for the pageIndex record component

entryRoute - the value for the entryRoute record component

state - the value for the state record component

Method Details

withState

public GuidePageRequest withState(Map<String,String> state)

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

entryRoute

public String entryRoute()

Returns the value of the entryRoute record component.

Returns:

the value of the entryRoute record component

state

public Map<String,String> state()

Returns the value of the state record component.

Returns:

the value of the state record component