Package com.vaadin.flow.router.internal

Class RouteRegistryHotswapper

java.lang.Object

com.vaadin.flow.router.internal.RouteRegistryHotswapper

All Implemented Interfaces:

VaadinHotswapper

public class RouteRegistryHotswapper
extends Object
implements VaadinHotswapper

A component that reacts on class changes to update route registries.

This class is meant to be used in combination wit Flow Hotswapper to immediately update routes registries when classes have been added or modified.

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

Since:

24.5

Constructor Summary

Constructors

Constructor	Description
RouteRegistryHotswapper()

Method Summary

Modifier and Type	Method	Description
boolean	onClassLoadEvent(VaadinService vaadinService, Set<Class<?>> classes, boolean redefined)	Updates both application registry, to reflect provided class changes.
boolean	onClassLoadEvent(VaadinSession session, Set<Class<?>> classes, boolean redefined)	Called by Vaadin hotswap entry point when one or more application classes have been updated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.hotswap.VaadinHotswapper

onHotswapComplete

Constructor Details

RouteRegistryHotswapper

public RouteRegistryHotswapper()

Method Details

onClassLoadEvent

public boolean onClassLoadEvent(VaadinService vaadinService,
 Set<Class<?>> classes,
 boolean redefined)

Updates both application registry, to reflect provided class changes.

For modified route classes, the following changes are taken into account:

• Route annotation removed: the previous route is removed from the registry
• Route.value() modified

Specified by:

onClassLoadEvent in interface VaadinHotswapper

Parameters:

vaadinService - active VaadinService instance.

classes - the set of changed classes.

redefined - true if the classes have been redefined by hotswap mechanism, false if they have been loaded for the first time by the ClassLoader.

Returns:

true if a browser page reload is required, false otherwise.

See Also:

• VaadinHotswapper.onClassLoadEvent(VaadinSession, Set, boolean)

onClassLoadEvent

public boolean onClassLoadEvent(VaadinSession session,
 Set<Class<?>> classes,
 boolean redefined)

Description copied from interface: VaadinHotswapper

Called by Vaadin hotswap entry point when one or more application classes have been updated.

This method is meant to perform updates at VaadinSession level. Operation targeting the entire application should be implemented in VaadinHotswapper.onClassLoadEvent(VaadinService, Set, boolean) method.

Specified by:

onClassLoadEvent in interface VaadinHotswapper

Parameters:

session - the VaadinSession to be potentially updated.

classes - the set of changed classes.

redefined - true if the classes have been redefined by hotswap mechanism, false if they have been loaded for the first time by the ClassLoader.

Returns:

true if a browser page reload is required, false otherwise.

See Also:

• VaadinHotswapper.onClassLoadEvent(VaadinService, Set, boolean)