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 RouteBaseData<T extends RouteBaseData>
java.lang.Object
com.vaadin.flow.router.RouteBaseData<T>
Type Parameters:
T - base data implementation
All Implemented Interfaces:
Direct Known Subclasses:
public abstract class RouteBaseData<T extends RouteBaseData>
extends Object
implements Comparable<T>, Serializable
Abstract base class for route and route alias data.
Only for read as data is immutable.
Since:
1.3
See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionRouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget) RouteBaseData constructor.
RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget) RouteBaseData constructor.
-
Method Summary
Modifier and TypeMethodDescriptionintbooleanGet
Routenavigation target.Class<? extends RouterLayout>Get the parent layout of
Route.List<Class<? extends RouterLayout>>Return the whole parent layout chain of route target.
Get
Routeroute parameters if any.Get the full route template of
Route.inthashCode()
-
Constructor Details
-
RouteBaseData
public RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget) RouteBaseData 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 urlparameters- supports only null or empty list. If a non empty list is passed andIllegalArgumentExceptionis raised.navigationTarget- route navigation targetThrows:
IllegalArgumentException- if parameters is not empty. -
RouteBaseData
public RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String, RouteParameterData> parameters, Class<? extends Component> navigationTarget) RouteBaseData constructor.
Parameters:
parentLayouts- route parent layout class chaintemplate- full route urlparameters- navigation target path parametersnavigationTarget- route navigation target
-
-
Method Details
-
getParentLayout
Get the parent layout of
Route.Returns:
route parent layout
-
getParentLayouts
Return the whole parent layout chain of route target.
Returns:
route parent layout chain
-
getTemplate
Get the full route template of
Route.Returns:
route template.
-
getRouteParameters
Get
Routeroute parameters if any.Returns:
route parameters names mapped with their defined regex.
-
compareTo
Specified by:
compareToin interfaceComparable<T extends RouteBaseData> -
equals
-
hashCode
public int hashCode()
-