Package com.vaadin.flow.internal

Interface DevModeHandlerManager

All Known Implementing Classes:

DevModeHandlerManagerImpl

public interface DevModeHandlerManager

Provides API to access to the DevModeHandler instance by a VaadinService.

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

Since:

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method	Description
DevModeHandler	getDevModeHandler()	Returns a DevModeHandler instance for the given service.
static Optional<DevModeHandler>	getDevModeHandler(VaadinContext context)	Gets the DevModeHandler.
static Optional<DevModeHandler>	getDevModeHandler(VaadinService service)	Gets the DevModeHandler.
Class<?>[]	getHandlesTypes()	The annotations the dev mode handler is interested in having scanned from the class path.
void	initDevModeHandler(Set<Class<?>> classes, VaadinContext context)	Starts up a new DevModeHandler.
void	launchBrowserInDevelopmentMode(String url)	Opens the given application URL in a browser if the application is running in development mode.
void	setDevModeHandler(DevModeHandler devModeHandler)	Defines the handler to use with this manager.
void	stopDevModeHandler()	Stops a running DevModeHandler.

Method Detail

getHandlesTypes

Class<?>[] getHandlesTypes()

The annotations the dev mode handler is interested in having scanned from the class path.

Returns:

an array of types the dev mode handler is interested in

initDevModeHandler

void initDevModeHandler(Set<Class<?>> classes,
                        VaadinContext context)
                 throws VaadinInitializerException

Starts up a new DevModeHandler.

Parameters:

classes - classes to check for npm- and js modules

context - servlet context we are running in

Throws:

VaadinInitializerException - if dev mode can't be initialized

stopDevModeHandler

void stopDevModeHandler()

Stops a running DevModeHandler.

setDevModeHandler

void setDevModeHandler(DevModeHandler devModeHandler)

Defines the handler to use with this manager.

Parameters:

devModeHandler - the dev mode handler to use

getDevModeHandler

DevModeHandler getDevModeHandler()

Returns a DevModeHandler instance for the given service.

Returns:

a DevModeHandler instance

launchBrowserInDevelopmentMode

void launchBrowserInDevelopmentMode(String url)

Opens the given application URL in a browser if the application is running in development mode.

Parameters:

url - the url to open

getDevModeHandler

static Optional<DevModeHandler> getDevModeHandler(VaadinService service)

Gets the DevModeHandler.

Parameters:

service - a Vaadin service

Returns:

an Optional containing a DevModeHandler instance or EMPTY if disabled

getDevModeHandler

static Optional<DevModeHandler> getDevModeHandler(VaadinContext context)

Gets the DevModeHandler.

Parameters:

context - the Vaadin context

Returns:

an Optional containing a DevModeHandler instance or EMPTY if disabled