Package com.vaadin.flow.router

Record Class NavigationEndedEvent.Completed

java.lang.Object
java.lang.Record
com.vaadin.flow.router.NavigationEndedEvent.Completed
Record Components:
navigationTarget - the class of the view that is shown, not null
parameters - the route parameters the view is shown with, not null, RouteParameters.empty() if there are none
All Implemented Interfaces:
NavigationEndedEvent.Outcome, Serializable
Enclosing class:
NavigationEndedEvent
public static record NavigationEndedEvent.Completed(Class<? extends Component> navigationTarget, RouteParameters parameters) extends Record implements NavigationEndedEvent.Outcome
The navigation showed a view.

The navigation target and the route parameters are those of the view that is shown after all forwards and reroutes, so they can differ from what the requested location resolves to. A forward or reroute to the same view with other parameters, such as from orders/17 to orders/42, is told apart from a plain navigation by the parameters.

See Also:

  • Constructor Details

    • Completed

      public Completed(Class<? extends Component> navigationTarget, RouteParameters parameters)
      Creates a new outcome.
      Parameters:
      navigationTarget - the class of the view that is shown, not null
      parameters - the route parameters the view is shown with, not null, RouteParameters.empty() if there are none

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

    • parameters

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