Package com.vaadin.flow.router

Record Class RouteParentContext

java.lang.Object
java.lang.Record
com.vaadin.flow.router.RouteParentContext
Record Components:
navigationTarget - the navigation target class whose parent is resolved
routeParameters - the route parameters the navigation target is resolved with; RouteParameters.empty() when no parameters are available
All Implemented Interfaces:
Serializable
public record RouteParentContext(Class<? extends Component> navigationTarget, RouteParameters routeParameters) extends Record implements Serializable
The context handed to a RouteParentResolver when resolving the logical parent of a route without an instance.

It exposes the navigation target class whose parent is being resolved and the RouteParameters it is resolved with, which is everything an instance-free parent resolver needs to compute the parent reference (for example to carry over a subset of the parameters to the parent route).

Since:
25.2
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • RouteParentContext

      public RouteParentContext(Class<? extends Component> navigationTarget, RouteParameters routeParameters)
      Creates an instance of a RouteParentContext record class.
      Parameters:
      navigationTarget - the value for the navigationTarget record component
      routeParameters - the value for the routeParameters 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. 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.

    • routeParameters

      public RouteParameters routeParameters()
      Returns the value of the routeParameters record component.
      Returns:
      the value of the routeParameters record component