Package com.vaadin.flow.router
Class RouteData
- java.lang.Object
-
- com.vaadin.flow.router.RouteBaseData<RouteData>
-
- com.vaadin.flow.router.RouteData
-
- All Implemented Interfaces:
Serializable
,Comparable<RouteData>
public class RouteData extends RouteBaseData<RouteData>
Data collection of information for a specific registered route target.Only for read as data is immutable.
- Since:
- 1.0
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RouteData(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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
List<RouteAliasData>
getRouteAliases()
Get all RouteAliases for this registered path.int
hashCode()
String
toString()
-
Methods inherited from class com.vaadin.flow.router.RouteBaseData
compareTo, getNavigationTarget, getParameters, getParentLayout, getParentLayouts, getRouteParameters, getTemplate, getUrl
-
-
-
-
Constructor Detail
-
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 providedIllegalArgumentException
is raised.- Parameters:
parentLayouts
- route parent layout class chaintemplate
- full route templateparameters
- supports only null or empty list. If a non empty list is passed andIllegalArgumentException
is raised.navigationTarget
- route navigation targetrouteAliases
- list of aliases for this route- Throws:
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
-
-
Method Detail
-
getRouteAliases
public List<RouteAliasData> getRouteAliases()
Get all RouteAliases for this registered path.- Returns:
- list of route aliases
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classRouteBaseData<RouteData>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classRouteBaseData<RouteData>
-
-