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.
RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases, MenuData menuData)	RouteData constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MenuData	getMenuData()	Get the menu data for this route.
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, getParentLayout, getParentLayouts, getRouteParameters, getRouteParametersList, getTemplate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

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 provided IllegalArgumentException is raised.

Parameters:

parentLayouts - route parent layout class chain

template - full route template

parameters - supports only null or empty list. If a non empty list is passed and IllegalArgumentException is raised.

navigationTarget - route navigation target

routeAliases - 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 chain

template - full route template

parameters - navigation target path parameters

navigationTarget - route navigation target

routeAliases - list of aliases for this route

RouteData

public RouteData(List<Class<? extends RouterLayout>> parentLayouts,
 String template,
 Map<String,RouteParameterData> parameters,
 Class<? extends Component> navigationTarget,
 List<RouteAliasData> routeAliases,
 MenuData menuData)

RouteData constructor.

Parameters:

parentLayouts - route parent layout class chain

template - full route template

parameters - navigation target path parameters

navigationTarget - route navigation target

routeAliases - list of aliases for this route

menuData - menu data for this route

Method Details

getRouteAliases

public List<RouteAliasData> getRouteAliases()

Get all RouteAliases for this registered path.

Returns:

list of route aliases

getMenuData

public MenuData getMenuData()

Get the menu data for this route.

Returns:

the menu data for this route

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class RouteBaseData<RouteData>

hashCode

public int hashCode()

Overrides:

hashCode in class RouteBaseData<RouteData>