Package com.vaadin.flow.router

Class RouteAliasData

java.lang.Object

com.vaadin.flow.router.RouteBaseData<RouteAliasData>

com.vaadin.flow.router.RouteAliasData

All Implemented Interfaces:

Serializable, Comparable<RouteAliasData>

public class RouteAliasData
extends RouteBaseData<RouteAliasData>

Route data for an 'alias' route. An alias route is a route that will get another path than this when it is resolved. The same target will still be resolved for this path, but the parent layouts may differ.

Only for read as data is immutable.

Since:

1.3

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)	AliasData constructor.
RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)	AliasData constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class com.vaadin.flow.router.RouteBaseData

compareTo, getNavigationTarget, getParentLayout, getParentLayouts, getRouteParameters, getTemplate

Methods inherited from class java.lang.Object

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

Constructor Details

RouteAliasData

public RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts,
 String template,
 List<Class<?>> parameters,
 Class<? extends Component> navigationTarget)

AliasData 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

Throws:

IllegalArgumentException - if parameters is not empty.

RouteAliasData

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

AliasData constructor.

Parameters:

parentLayouts - route parent layout class chain

template - full route template

parameters - navigation target path parameters

navigationTarget - route navigation target

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class RouteBaseData<RouteAliasData>

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class RouteBaseData<RouteAliasData>