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:
Serializable
,Comparable<T>
- Direct Known Subclasses:
RouteAliasData
,RouteData
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor 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 Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
compareTo(T otherRouteData)
boolean
equals(Object obj)
Class<? extends Component>
getNavigationTarget()
GetRoute
navigation target.List<Class<?>>
getParameters()
Deprecated.usegetRouteParameters()
instead.Class<? extends RouterLayout>
getParentLayout()
Get the parent layout ofRoute
.List<Class<? extends RouterLayout>>
getParentLayouts()
Return the whole parent layout chain of route target.Map<String,RouteParameterData>
getRouteParameters()
GetRoute
route parameters if any.String
getTemplate()
Get the full route template ofRoute
.String
getUrl()
Deprecated.usegetTemplate()
instead.int
hashCode()
-
-
-
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 providedIllegalArgumentException
is raised.- Parameters:
parentLayouts
- route parent layout class chaintemplate
- full route urlparameters
- supports only null or empty list. If a non empty list is passed andIllegalArgumentException
is raised.navigationTarget
- route navigation target- Throws:
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 ofRoute
.- 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.usegetTemplate()
instead.Get the full route url ofRoute
.- Returns:
- route url
-
getTemplate
public String getTemplate()
Get the full route template ofRoute
.- Returns:
- route template.
-
getParameters
@Deprecated public List<Class<?>> getParameters()
Deprecated.usegetRouteParameters()
instead.GetRoute
route parameters types if any.- Returns:
- route parameters types.
-
getRouteParameters
public Map<String,RouteParameterData> getRouteParameters()
GetRoute
route parameters if any.- Returns:
- route parameters names mapped with their defined regex.
-
getNavigationTarget
public Class<? extends Component> getNavigationTarget()
GetRoute
navigation target.- Returns:
- navigation target
-
compareTo
public int compareTo(T otherRouteData)
- Specified by:
compareTo
in interfaceComparable<T extends RouteBaseData>
-
-