com.vaadin.flow.router.internal

Class ConfiguredRoutes

java.lang.Object

com.vaadin.flow.router.internal.ConfiguredRoutes

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConfigureRoutes

public class ConfiguredRoutes
extends Object
implements Serializable

Route configuration class that is used as a value object.

Note! This is always immutable and any changes should be made from ConfigureRoutes.

Since:

1.3

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfiguredRoutes() Create an immutable RouteConfiguration.
ConfiguredRoutes(ConfigureRoutes original) Create a mutable or immutable configuration with original configuration information.

Method Summary

Modifier and Type	Method and Description
Class<? extends Component>	getExceptionHandlerByClass(Class<?> exceptionClass) Get a exception handler by exception class.
Map<Class<? extends Exception>,Class<? extends Component>>	getExceptionHandlers() Get all registered exception handlers as a exception-to-handler map.
List<Class<? extends RouterLayout>>	getParentLayouts(String path, Class<? extends Component> navigationTarget) Return the parent layout chain for given navigation target on the target path.
Optional<Class<? extends Component>>	getRoute(String pathString, List<String> segments) Get the route class matching the given path and path segments.
protected List<String>	getRoutePaths(Class<? extends Component> routeTarget) Collect all routes for which given routeTarget is registered.
Set<String>	getRoutes() Get all registered paths that have been registered.
protected Map<String,RouteTarget>	getRoutesMap()
protected RouteTarget	getRouteTarget(String path) Get the RouteTarget stored for the given path.
String	getTargetRoute(Class<? extends Component> navigationTarget) Get the route path String for the given navigation target class.
Map<Class<? extends Component>,String>	getTargetRoutes() Get all registered target routes for this configuration.
boolean	hasRoute(String path) See if configuration contains a registered route for given path.
boolean	hasRoute(String pathString, List<String> segments) Check if configuration holds a route for given path with possible path segments.
boolean	hasRouteTarget(Class<? extends Component> targetRoute) Check it the given route target has been registered to the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredRoutes

public ConfiguredRoutes()

Create an immutable RouteConfiguration.

ConfiguredRoutes

public ConfiguredRoutes(ConfigureRoutes original)

Create a mutable or immutable configuration with original configuration information.

Parameters:

original - original configuration to get data from

Method Detail

getRoutesMap

protected Map<String,RouteTarget> getRoutesMap()

getRoutePaths

protected List<String> getRoutePaths(Class<? extends Component> routeTarget)

Collect all routes for which given routeTarget is registered. This is mainly for handling route aliases as reading from the class annotations doesn't specifically return the actual registrations as they can change during runtime.

Parameters:

routeTarget - route target to collect registered paths for

Returns:

list of routes this routeTarget is registered for

hasRoute

public boolean hasRoute(String path)

See if configuration contains a registered route for given path.

Parameters:

path - path to check

Returns:

true if configuration contains route

hasRoute

public boolean hasRoute(String pathString,
                        List<String> segments)

Check if configuration holds a route for given path with possible path segments.

Parameters:

pathString - path string to check

segments - path segments for route

Returns:

true if a route is found, else false

hasRouteTarget

public boolean hasRouteTarget(Class<? extends Component> targetRoute)

Check it the given route target has been registered to the configuration.

Parameters:

targetRoute - target to check registration status for

Returns:

true if target is found in configuration

getRoute

public Optional<Class<? extends Component>> getRoute(String pathString,
                                                     List<String> segments)

Get the route class matching the given path and path segments.

Parameters:

pathString - string to get the route for

segments - possible path segments

Returns:

Optional containing the navigationTarget class if found

getRoutes

public Set<String> getRoutes()

Get all registered paths that have been registered.

Returns:

Set containing all the registered paths

getTargetRoutes

public Map<Class<? extends Component>,String> getTargetRoutes()

Get all registered target routes for this configuration.

Returns:

component-to-path map of all target routes

getTargetRoute

public String getTargetRoute(Class<? extends Component> navigationTarget)

Get the route path String for the given navigation target class.

Parameters:

navigationTarget - navigationTarget to get registered route for

Returns:

base route string if target class found

getExceptionHandlerByClass

public Class<? extends Component> getExceptionHandlerByClass(Class<?> exceptionClass)

Get a exception handler by exception class.

Parameters:

exceptionClass - exception class to get exception handler for

Returns:

exception handler if found

getExceptionHandlers

public Map<Class<? extends Exception>,Class<? extends Component>> getExceptionHandlers()

Get all registered exception handlers as a exception-to-handler map.

Returns:

all registered exception handlers

getParentLayouts

public List<Class<? extends RouterLayout>> getParentLayouts(String path,
                                                            Class<? extends Component> navigationTarget)

Return the parent layout chain for given navigation target on the target path.

Parameters:

path - path to get parent layout chain for

navigationTarget - navigation target on path to get parent layout chain for

Returns:

list of parent layout chain

getRouteTarget

protected RouteTarget getRouteTarget(String path)

Get the RouteTarget stored for the given path.

Parameters:

path - path to get route target for

Returns:

route target for path, null if nothing registered