Package com.vaadin.copilot

Class Copilot

java.lang.Object

com.vaadin.copilot.Copilot

All Implemented Interfaces:

DevToolsMessageHandler

public class Copilot
extends Object
implements DevToolsMessageHandler

This is the entry point for copilot.

It is a singleton with the main purpose to forward messages to the correct CopilotSession instance, based on which session the message is related to.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ISSUE_TRACKER
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
Copilot()

Method Summary

Modifier and Type	Method	Description
void	handleConnect(DevToolsInterface devToolsInterface)	Called when a browser connects.
boolean	handleMessage(String command, elemental.json.JsonObject data, DevToolsInterface devToolsInterface)	Called when a message from the browser arrives.
static boolean	isDevelopmentMode()	Check if copilot is running in development mode i.e.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.base.devserver.DevToolsMessageHandler

handleDisconnect

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

ISSUE_TRACKER

public static final String ISSUE_TRACKER

See Also:

• Constant Field Values

Constructor Details

Copilot

public Copilot()

Method Details

handleConnect

public void handleConnect(DevToolsInterface devToolsInterface)

Description copied from interface: DevToolsMessageHandler

Called when a browser connects.

This happens on each refresh but also when the application is opened in a new browser tab or window.

Specified by:

handleConnect in interface DevToolsMessageHandler

Parameters:

devToolsInterface - for interaction with the development tools, e.g. sending a message

handleMessage

public boolean handleMessage(String command,
 elemental.json.JsonObject data,
 DevToolsInterface devToolsInterface)

Description copied from interface: DevToolsMessageHandler

Called when a message from the browser arrives.

Specified by:

handleMessage in interface DevToolsMessageHandler

Parameters:

command - the command received

data - the data received

devToolsInterface - for interaction with the development tools, e.g. sending a message

Returns:

true if the message was handled and should not be passed on to further handlers

isDevelopmentMode

public static boolean isDevelopmentMode()

Check if copilot is running in development mode i.e. is being developed.

Unrelated to Vaadin's production mode.

Returns:

true if copilot is running in development mode