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>, Serializable
Abstract 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 url, List<Class<?>> parameters, Class<? extends Component> navigationTarget)
RouteBaseData constructor.
-
Method Summary
All Methods Modifier and Type Method and Description int
compareTo(T 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<Class<? extends RouterLayout>>
getParentLayouts()
Return the whole parent layout chain of route target.
String
getUrl()
Get the full route url of
Route
.int
hashCode()
-
-
-
Constructor Detail
-
RouteBaseData
public RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String url, List<Class<?>> parameters, Class<? extends Component> navigationTarget)
RouteBaseData constructor.
Parameters:
parentLayouts
- route parent layout class chainurl
- 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
-
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
-
compareTo
public int compareTo(T otherRouteData)
Specified by:
compareTo
in interfaceComparable<T extends RouteBaseData>
-
-