Record Class GuideDestination

java.lang.Object

java.lang.Record

ke.ric.api.guide.GuideDestination

public record GuideDestination(String guideId, String route, int pageIndex, Map<String,String> state)
extends Record

Immutable, addon-owned deep link. Contains no callbacks or playable item metadata.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	guideId()	Returns the value of the guideId record component.
final int	hashCode()	Returns a hash code value for this object.
int	pageIndex()	Returns the value of the pageIndex record component.
String	route()	Returns the value of the route 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.

Methods inherited from class Object

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

Constructor Details

GuideDestination

public GuideDestination(String guideId,
 String route)

GuideDestination

public GuideDestination(String guideId,
 String route,
 int pageIndex,
 Map<String,String> state)

Creates an instance of a GuideDestination record class.

Parameters:

guideId - the value for the guideId record component

route - the value for the route record component

pageIndex - the value for the pageIndex record component

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

guideId

public String guideId()

Returns the value of the guideId record component.

Returns:

the value of the guideId record component

route

public String route()

Returns the value of the route record component.

Returns:

the value of the route record component

pageIndex

public int pageIndex()

Returns the value of the pageIndex record component.

Returns:

the value of the pageIndex record component

state

public Map<String,String> state()

Returns the value of the state record component.

Returns:

the value of the state record component