Record Class GuideAction.Open

java.lang.Object

java.lang.Record

ke.ric.api.guide.GuideAction.Open

All Implemented Interfaces:

GuideAction

Enclosing interface:

GuideAction

public static record GuideAction.Open(String route, int pageIndex, Map<String,String> state)
extends Record
implements GuideAction

Open a child destination. A null state inherits the current view's state.

Nested Class Summary

Nested classes/interfaces inherited from interface GuideAction

GuideAction.Cancel, GuideAction.Message, GuideAction.Open, GuideAction.Pick, GuideAction.Recipe, GuideAction.Refresh, GuideAction.Select, GuideAction.Tutorial

Modifier and Type	Interface	Description
static final record	GuideAction.Cancel	Return from a picker with its original state.
static final record	GuideAction.Message
static final record	GuideAction.Open	Open a child destination.
static final record	GuideAction.Pick	Open a temporary picker without changing navigation history.
static final record	GuideAction.Recipe	Open a real station recipe using Core history, without retaining an addon callback.
static final record	GuideAction.Refresh	Replace the current view in place.
static final record	GuideAction.Select	Return from a picker with replacement state for its originating view.
static final record	GuideAction.Tutorial	Launch a current lesson, or the named catalogue when lessonId is empty.

Constructor Summary

Constructors

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

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	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

Open

public Open(String route)

Open

public Open(String route,
 Map<String,String> state)

Open

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

Creates an instance of a Open record class.

Parameters:

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.

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