com.vaadin.flow.router

Class Router

java.lang.Object

com.vaadin.flow.router.Router

All Implemented Interfaces:

Serializable

public class Router
extends Object
implements Serializable

The router takes care of serving content when the user navigates within a site or an application.

Since:

1.0.

Author:

Vaadin Ltd

See Also:

Route, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Router(RouteRegistry registry) Constructs a new router with the given route registry and a DefaultRouteResolver.

Method Summary

Modifier and Type	Method and Description
RouteRegistry	getRegistry()
List<RouteData>	getRoutes() Get all available routes.
Map<Class<? extends RouterLayout>,List<RouteData>>	getRoutesByParent() Get all available routes collected by parent layout.
<T,C extends Component & HasUrlParameter<T>> String	getUrl(Class<? extends C> navigationTarget, List<T> parameters) Get the url string for given navigation target with the parameters in the url.
<T,C extends Component & HasUrlParameter<T>> String	getUrl(Class<? extends C> navigationTarget, T parameter) Get the url string for given navigation target with the parameter in the url.
String	getUrl(Class<? extends Component> navigationTarget) Get the registered url string for given navigation target.
String	getUrlBase(Class<? extends Component> navigationTarget) Return the url base without any url parameters.
void	initializeUI(UI ui, VaadinRequest initRequest) Enables navigation for a new UI instance.
int	navigate(UI ui, Location location, NavigationTrigger trigger) Navigates the given UI to the given location.
static String	resolve(Class<?> component, Route route) Gets the effective route path value of the annotated class.
Optional<NavigationState>	resolveNavigationTarget(String pathInfo, Map<String,String[]> parameterMap) Resolve the navigation target for given path and parameter map using the router routeResolver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Router

public Router(RouteRegistry registry)

Constructs a new router with the given route registry and a DefaultRouteResolver.

Parameters:

registry - the route registry to use, not null

Method Detail

initializeUI

public void initializeUI(UI ui,
                         VaadinRequest initRequest)

Enables navigation for a new UI instance. This initializes the UI content based on the location used for loading the UI and sets up the UI to be updated when the user navigates to some other location.

Parameters:

ui - the UI that navigation should be set up for

initRequest - the Vaadin request that bootstraps the provided UI

resolveNavigationTarget

public Optional<NavigationState> resolveNavigationTarget(String pathInfo,
                                                         Map<String,String[]> parameterMap)

Resolve the navigation target for given path and parameter map using the router routeResolver.

Parameters:

pathInfo - the path relative to the application

parameterMap - A mapping of parameter names to arrays of parameter values

Returns:

NavigationTarget for the given path and parameter map if found

navigate

public int navigate(UI ui,
                    Location location,
                    NavigationTrigger trigger)

Navigates the given UI to the given location.

This method just shows the given location on the page and doesn't update the browser location (and page history). Use the UI.navigate(String, QueryParameters) method if you want to update the browser location as well.

Parameters:

ui - the UI to update, not null

location - the location to navigate to, not null

trigger - the type of user action that triggered this navigation, not null

Returns:

the HTTP status code resulting from the navigation

See Also:

UI.navigate(String), UI.navigate(String, QueryParameters)

getUrl

public String getUrl(Class<? extends Component> navigationTarget)

Get the registered url string for given navigation target.

Note! If the navigation target has a url parameter that is required then this method will throw and IllegalArgumentException.

Parameters:

navigationTarget - navigation target to get url for

Returns:

url for the navigation target

Throws:

IllegalArgumentException - if the navigation target requires a parameter

getUrlBase

public String getUrlBase(Class<? extends Component> navigationTarget)

Return the url base without any url parameters.

Parameters:

navigationTarget - navigation target to get url for

Returns:

url base without url parameters

getUrl

public <T,C extends Component & HasUrlParameter<T>> String getUrl(Class<? extends C> navigationTarget,
                                                                  T parameter)

Get the url string for given navigation target with the parameter in the url.

Note! Given parameter is checked for correct class type. This means that if the navigation target defined parameter is of type Boolean then calling getUrl with a String will fail.

Type Parameters:

T - url parameter type

C - navigation target type

Parameters:

navigationTarget - navigation target to get url for

parameter - parameter to embed into the generated url

Returns:

url for the navigation target with parameter

getUrl

public <T,C extends Component & HasUrlParameter<T>> String getUrl(Class<? extends C> navigationTarget,
                                                                  List<T> parameters)

Get the url string for given navigation target with the parameters in the url.

Note! Given parameter is checked for correct class type. This means that if the navigation target defined parameter is of type Boolean then calling getUrl with a String will fail.

Type Parameters:

T - url parameter type

C - navigation target type

Parameters:

navigationTarget - navigation target to get url for

parameters - parameters to embed into the generated url, not null

Returns:

url for the navigation target with parameter

getRegistry

public RouteRegistry getRegistry()

getRoutes

public List<RouteData> getRoutes()

Get all available routes.

Returns:

RouteData for all registered routes

getRoutesByParent

public Map<Class<? extends RouterLayout>,List<RouteData>> getRoutesByParent()

Get all available routes collected by parent layout.

Returns:

map of parent url to route

resolve

public static String resolve(Class<?> component,
                             Route route)

Gets the effective route path value of the annotated class.

Parameters:

component - the component where the route points to

route - the annotation

Returns:

The value of the annotation or naming convention based value if no explicit value is given.