com.vaadin.flow.router.
Class RouteData
- java.lang.Object
-
- com.vaadin.flow.router.RouteData
-
All Implemented Interfaces:
public class RouteData extends Object implements Comparable<RouteData>, Serializable
Data collection of information for a specific registered route target.
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
RouteData.AliasData
Data class with information pertaining to the
RouteAlias
.
-
Constructor Summary
Constructors Constructor and Description RouteData(Class<? extends RouterLayout> parentLayout, String url, List<Class<?>> parameters, Class<? extends Component> navigationTarget)
RouteData constructor.
-
Method Summary
All Methods Modifier and Type Method and Description int
compareTo(RouteData otherRouteData)
boolean
equals(Object obj)
Class<? extends Component>
getNavigationTarget()
Get
Route
navigation target.List<Class<?>>
getParameters()
Get
Route
url parameters if any.Class<? extends RouterLayout>
getParentLayout()
Get the parent layout of
Route
.List<RouteData.AliasData>
getRouteAliases()
Get all
RouteAlias
es for this registeredRoute
.String
getUrl()
Get the full route url of
Route
.
-
-
-
Constructor Detail
-
RouteData
public RouteData(Class<? extends RouterLayout> parentLayout, String url, List<Class<?>> parameters, Class<? extends Component> navigationTarget)
RouteData constructor.
Parameters:
parentLayout
- route parent layout classurl
- full route urlparameters
- navigation target path parametersnavigationTarget
- route navigation target
-
-
Method Detail
-
getParentLayout
public Class<? extends RouterLayout> getParentLayout()
Get the parent layout of
Route
.Returns:
route parent layout
-
getParameters
public List<Class<?>> getParameters()
Get
Route
url parameters if any.Returns:
url parameters (by type and in order)
-
getNavigationTarget
public Class<? extends Component> getNavigationTarget()
Get
Route
navigation target.Returns:
navigation target
-
getRouteAliases
public List<RouteData.AliasData> getRouteAliases()
Get all
RouteAlias
es for this registeredRoute
.Returns:
list of route aliases
-
compareTo
public int compareTo(RouteData otherRouteData)
Specified by:
compareTo
in interfaceComparable<RouteData>
-
-