Package com.vaadin.copilot

Class RouteHandler

java.lang.Object

com.vaadin.copilot.CopilotCommand

com.vaadin.copilot.RouteHandler

public class RouteHandler
extends CopilotCommand

Provides server side route information to the client.

Field Summary

Fields inherited from class com.vaadin.copilot.CopilotCommand

currentSession, KEY_CANCEL_REQ_ID, KEY_REQ_ID

Constructor Summary

Constructors

Constructor	Description
RouteHandler(SourceSyncChecker sourceSyncChecker)

Method Summary

Modifier and Type	Method	Description
boolean	canBeParallelCommand(String command)	Checks if given command can be handled asynchronously.
static Set<Class<? extends com.vaadin.flow.router.RouterLayout>>	getLayoutClasses(com.vaadin.flow.server.VaadinSession vaadinSession, List<com.vaadin.flow.router.RouteData> routeDataList)	Returns the unique layout classes that are used in given route list
static Set<Class<?>>	getServerAutoLayouts(com.vaadin.flow.server.VaadinSession vaadinSession)
static List<com.vaadin.flow.router.RouteData>	getServerRoutes(com.vaadin.flow.server.VaadinSession vaadinSession)
boolean	handleMessage(String command, tools.jackson.databind.JsonNode data, com.vaadin.base.devserver.DevToolsInterface devToolsInterface)	Called whenever there is a message from the browser.

Methods inherited from class com.vaadin.copilot.CopilotCommand

getProjectFileManager, getVaadinContext, getVaadinSession, handleConnect

Methods inherited from class java.lang.Object

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

Constructor Details

RouteHandler

public RouteHandler(SourceSyncChecker sourceSyncChecker)

Method Details

handleMessage

public boolean handleMessage(String command,
 tools.jackson.databind.JsonNode data,
 com.vaadin.base.devserver.DevToolsInterface devToolsInterface)

Description copied from class: CopilotCommand

Called whenever there is a message from the browser. Implementations should check if the command is for them, handle it and return true if the command was handled.

Specified by:

handleMessage in class CopilotCommand

Parameters:

command - the command to handle

data - the data for the command

devToolsInterface - the devtools interface for the connection

Returns:

true if the command was handled, false otherwise

canBeParallelCommand

public boolean canBeParallelCommand(String command)

Description copied from class: CopilotCommand

Checks if given command can be handled asynchronously. If the handler can't be asynchronous at all, it can return false always. But if you want to handle one or more commands asynchronously, you should specify the exact command to prevent handling commands that are not part of the handler as asynchronous.

Overrides:

canBeParallelCommand in class CopilotCommand

Parameters:

command - the command to check

Returns:

true if the command can be handled by this command handler

getServerRoutes

public static List<com.vaadin.flow.router.RouteData> getServerRoutes(com.vaadin.flow.server.VaadinSession vaadinSession)

getServerAutoLayouts

public static Set<Class<?>> getServerAutoLayouts(com.vaadin.flow.server.VaadinSession vaadinSession)

getLayoutClasses

public static Set<Class<? extends com.vaadin.flow.router.RouterLayout>> getLayoutClasses(com.vaadin.flow.server.VaadinSession vaadinSession,
 List<com.vaadin.flow.router.RouteData> routeDataList)

Returns the unique layout classes that are used in given route list

Parameters:

vaadinSession - Vaadin session to access router

routeDataList - List of routes

Returns:

the unique classes of Layouts