Module no.ntnu.principes
Package no.ntnu.principes.event.navigation

Record Class NavigateEvent.NavigationPayload

java.lang.Object
java.lang.Record
no.ntnu.principes.event.navigation.NavigateEvent.NavigationPayload
Record Components:
route - the target route or identifier for the navigation action
type - the type of navigation action to perform (e.g., PUSH, REPLACE, POP)
params - a map of optional parameters to accompany the navigation action
Enclosing class:
NavigateEvent
public static record NavigateEvent.NavigationPayload(String route, NavigateEvent.NavigationType type, Map<String,Object> params) extends Record
Represents the payload for a navigation event, providing details about the navigation action, target route, and optional parameters for the navigation.

This payload is used to encapsulate data needed for navigation transitions, including:

  • The target route or identifier to navigate to
  • The type of navigation action to perform (e.g., PUSH, REPLACE, POP)
  • Additional parameters as a map of key-value pairs for contextual information

  • Constructor Details

    • NavigationPayload

      public NavigationPayload(String route, NavigateEvent.NavigationType type, Map<String,Object> params)
      Creates an instance of a NavigationPayload record class.
      Parameters:
      route - the value for the route record component
      type - the value for the type record component
      params - the value for the params record component

  • Method Details

    • getParam

      public <T> Optional<T> getParam(String key, Class<T> type)
      Retrieves a parameter from the navigation payload by its key and type if it exists.

      This method checks if the specified key exists in the parameters map and attempts to cast the value to the specified type. If the key does not exist or the value cannot be cast to the specified type, an empty Optional is returned.

      Type Parameters:
      T - the type of the parameter value
      Parameters:
      key - the key of the parameter to retrieve
      type - the class type to which the parameter value should be cast
      Returns:
      an Optional containing the parameter value if it exists and is of the specified type, or an empty Optional if the key does not exist or the value cannot be cast to the specified type

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

    • route

      public String route()
      Returns the value of the route record component.
      Returns:
      the value of the route record component

    • type

      public NavigateEvent.NavigationType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • params

      public Map<String,Object> params()
      Returns the value of the params record component.
      Returns:
      the value of the params record component