com.vaadin.flow.router.internal

Class RouteUtil

java.lang.Object

com.vaadin.flow.router.internal.RouteUtil

public class RouteUtil
extends Object

Utility class with methods for route handling.

For internal use only. May be renamed or removed in a future release.

Since:

1.3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RouteUtil()

Method Summary

Modifier and Type	Method and Description
static List<Class<? extends RouterLayout>>	getParentLayouts(Class<?> component, String path) Deprecated. Use getParentLayouts(VaadinContext, Class, String)
static List<Class<? extends RouterLayout>>	getParentLayouts(VaadinContext context, Class<?> component, String path) Get parent layouts for navigation target according to the Route or RouteAlias annotation.
static List<Class<? extends RouterLayout>>	getParentLayoutsForNonRouteTarget(Class<?> navigationTarget) Collect possible route parent layouts for a navigation target that is not annotated with Route nor RouteAlias, but may still contain ParentLayout.
static String	getRouteAliasPath(Class<?> component, RouteAlias alias) Get the actual route path including all parent layout RoutePrefix.
static String	getRoutePath(Class<?> component, Route route) Deprecated. Use getRoutePath(VaadinContext, Class) instead
static String	getRoutePath(VaadinContext context, Class<?> component) Get the actual route path including all parent layout RoutePrefix.
static Class<? extends RouterLayout>	getTopParentLayout(Class<?> component, String path) Deprecated. Use getTopParentLayout(VaadinContext, Class, String) instead
static Class<? extends RouterLayout>	getTopParentLayout(VaadinContext context, Class<?> component, String path) Get the top most parent layout for navigation target according to the Route or RouteAlias annotation.
static String	resolve(Class<?> component, Route route) Deprecated. Use resolve(VaadinContext, Class) or RoutePathProvider directly instead
static String	resolve(VaadinContext context, Class<?> component) Gets the effective route path value of the annotated class.
static void	updateRouteRegistry(RouteRegistry registry, Set<Class<?>> addedClasses, Set<Class<?>> modifiedClasses, Set<Class<?>> deletedClasses) Updates route registry as necessary when classes have been added / modified / deleted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouteUtil

protected RouteUtil()

Method Detail

getParentLayouts

@Deprecated
public static List<Class<? extends RouterLayout>> getParentLayouts(Class<?> component,
                                                                               String path)

Deprecated. Use getParentLayouts(VaadinContext, Class, String)

Get parent layouts for navigation target according to the Route or RouteAlias annotation.

Parameters:

component - navigation target to get parents for

path - path used to get navigation target so we know which annotation to handle

Returns:

parent layouts for target

getParentLayouts

public static List<Class<? extends RouterLayout>> getParentLayouts(VaadinContext context,
                                                                   Class<?> component,
                                                                   String path)

Get parent layouts for navigation target according to the Route or RouteAlias annotation.

Parameters:

context - a Vaadin context

component - navigation target to get parents for

path - path used to get navigation target so we know which annotation to handle

Returns:

parent layouts for target

getRoutePath

@Deprecated
public static String getRoutePath(Class<?> component,
                                              Route route)

Deprecated. Use getRoutePath(VaadinContext, Class) instead

Get the actual route path including all parent layout RoutePrefix.

Parameters:

component - navigation target component to get route path for

route - route annotation to check

Returns:

actual path for given route target

getRoutePath

public static String getRoutePath(VaadinContext context,
                                  Class<?> component)

Get the actual route path including all parent layout RoutePrefix.

Parameters:

context - a Vaadin context

component - navigation target component to get route path for

Returns:

actual path for given route target

getRouteAliasPath

public static String getRouteAliasPath(Class<?> component,
                                       RouteAlias alias)

Get the actual route path including all parent layout RoutePrefix.

Parameters:

component - navigation target component to get route path for

alias - route alias annotation to check

Returns:

actual path for given route alias target

getParentLayoutsForNonRouteTarget

public static List<Class<? extends RouterLayout>> getParentLayoutsForNonRouteTarget(Class<?> navigationTarget)

Collect possible route parent layouts for a navigation target that is not annotated with Route nor RouteAlias, but may still contain ParentLayout. Mainly error navigation targets.

Parameters:

navigationTarget - route to check parent layouts for

Returns:

list of parent layouts

getTopParentLayout

@Deprecated
public static Class<? extends RouterLayout> getTopParentLayout(Class<?> component,
                                                                           String path)

Deprecated. Use getTopParentLayout(VaadinContext, Class, String) instead

Get the top most parent layout for navigation target according to the Route or RouteAlias annotation. Also handles non route targets with ParentLayout.

Parameters:

component - navigation target to get top most parent for

path - path used to get navigation target so we know which annotation to handle or null for error views.

Returns:

top parent layout for target or null if none found

getTopParentLayout

public static Class<? extends RouterLayout> getTopParentLayout(VaadinContext context,
                                                               Class<?> component,
                                                               String path)

Get the top most parent layout for navigation target according to the Route or RouteAlias annotation. Also handles non route targets with ParentLayout.

Parameters:

component - navigation target to get top most parent for

path - path used to get navigation target so we know which annotation to handle or null for error views.

Returns:

top parent layout for target or null if none found

resolve

@Deprecated
public static String resolve(Class<?> component,
                                         Route route)

Deprecated. Use resolve(VaadinContext, Class) or RoutePathProvider directly instead

Gets the effective route path value of the annotated class.

Parameters:

component - the component where the route points to

route - the annotation

Returns:

The value of the annotation or naming convention based value if no explicit value is given.

resolve

public static String resolve(VaadinContext context,
                             Class<?> component)

Gets the effective route path value of the annotated class.

Parameters:

context - a Vaadin contexxt

component - the component where the route points to

Returns:

The value of the annotation or naming convention based value if no explicit value is given.

updateRouteRegistry

public static void updateRouteRegistry(RouteRegistry registry,
                                       Set<Class<?>> addedClasses,
                                       Set<Class<?>> modifiedClasses,
                                       Set<Class<?>> deletedClasses)

Updates route registry as necessary when classes have been added / modified / deleted.

Parameters:

registry - route registry

addedClasses - added classes

modifiedClasses - modified classes

deletedClasses - deleted classes