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.
Class RouteBaseData<T extends RouteBaseData>
- java.lang.Object
-
- com.vaadin.flow.router.RouteBaseData<T>
-
Type Parameters:
T- base data implementationAll Implemented Interfaces:
Direct Known Subclasses:
public abstract class RouteBaseData<T extends RouteBaseData> extends Object implements Comparable<T>, SerializableAbstract base class for route and route alias data.
Only for read as data is immutable.
Since:
1.3
See Also:
-
-
Constructor Summary
Constructors Constructor and Description RouteBaseData(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
All Methods Modifier and Type Method and Description intcompareTo(T otherRouteData)booleanequals(Object obj)Class<? extends Component>getNavigationTarget()Get
Routenavigation target.List<Class<?>>getParameters()Deprecated.
usegetRouteParameters()instead.Class<? extends RouterLayout>getParentLayout()Get the parent layout of
Route.List<Class<? extends RouterLayout>>getParentLayouts()Return the whole parent layout chain of route target.
Map<String,RouteParameterData>getRouteParameters()Get
Routeroute parameters if any.StringgetTemplate()Get the full route template of
Route.StringgetUrl()Deprecated.
usegetTemplate()instead.inthashCode()
-
-
-
Constructor Detail
-
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 Detail
-
getParentLayout
public Class<? extends RouterLayout> getParentLayout()Get the parent layout of
Route.Returns:
route parent layout
-
getParentLayouts
public List<Class<? extends RouterLayout>> getParentLayouts()Return the whole parent layout chain of route target.
Returns:
route parent layout chain
-
getUrl
@Deprecated public String getUrl()Deprecated. use
getTemplate()instead.Get the full route url of
Route.Returns:
route url
-
getTemplate
public String getTemplate()Get the full route template of
Route.Returns:
route template.
-
getParameters
@Deprecated public List<Class<?>> getParameters()Deprecated. use
getRouteParameters()instead.Get
Routeroute parameters types if any.Returns:
route parameters types.
-
getRouteParameters
public Map<String,RouteParameterData> getRouteParameters()Get
Routeroute parameters if any.Returns:
route parameters names mapped with their defined regex.
-
getNavigationTarget
public Class<? extends Component> getNavigationTarget()Get
Routenavigation target.Returns:
navigation target
-
compareTo
public int compareTo(T otherRouteData)Specified by:
compareToin interfaceComparable<T extends RouteBaseData>
-
-