We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.router.
Package com.vaadin.flow.router
Class RouteData
All Implemented Interfaces:
Data collection of information for a specific registered route target.
Only for read as data is immutable.
Since:
1.0
See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionRouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases) RouteData constructor.
RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases) RouteData constructor.
RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases, MenuData menuData) RouteData constructor.
-
Method Summary
Methods inherited from class com.vaadin.flow.router.RouteBaseData
compareTo, getNavigationTarget, getParentLayout, getParentLayouts, getRouteParameters, getRouteParametersList, getTemplate
-
Constructor Details
-
RouteData
public RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases) RouteData constructor. This constructor doesn't support parameters. When a non empty List is provided
IllegalArgumentExceptionis raised.Parameters:
parentLayouts- route parent layout class chaintemplate- full route templateparameters- supports only null or empty list. If a non empty list is passed andIllegalArgumentExceptionis raised.navigationTarget- route navigation targetrouteAliases- list of aliases for this routeThrows:
IllegalArgumentException- if parameters is not empty. -
RouteData
public RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases) RouteData constructor.
Parameters:
parentLayouts- route parent layout class chaintemplate- full route templateparameters- navigation target path parametersnavigationTarget- route navigation targetrouteAliases- list of aliases for this route -
RouteData
public RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases, MenuData menuData) RouteData constructor.
Parameters:
parentLayouts- route parent layout class chaintemplate- full route templateparameters- navigation target path parametersnavigationTarget- route navigation targetrouteAliases- list of aliases for this routemenuData- menu data for this route
-
-
Method Details
-
getRouteAliases
Get all RouteAliases for this registered path.
Returns:
list of route aliases
-
getMenuData
Get the menu data for this route.
Returns:
the menu data for this route
-
toString
-
equals
Overrides:
equalsin classRouteBaseData<RouteData> -
hashCode
public int hashCode()Overrides:
hashCodein classRouteBaseData<RouteData>
-