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 and Description
DevModeHandler	getDevModeHandler() Returns a DevModeHandler instance for the given service.
static Optional<DevModeHandler>	getDevModeHandler(VaadinService service) Create a DevModeHandler if factory available.
Class<?>[]	getHandlesTypes() A dev mode handler implementation is interested in certain annotations to be be scanned from the class path and passed to the initDevModeHandler(Set, VaadinContext) initializer.
void	initDevModeHandler(Set<Class<?>> classes, VaadinContext context) Starts up a new DevModeHandler.
boolean	isDevModeAlreadyStarted(VaadinContext context) Returns whether DevModeHandler has been already started or not.

Method Detail

getHandlesTypes

Class<?>[] getHandlesTypes()

A dev mode handler implementation is interested in certain annotations to be be scanned from the class path and passed to the initDevModeHandler(Set, VaadinContext) initializer.

Returns:

an array of types the dev mode handler is interested id.

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

getDevModeHandler

DevModeHandler getDevModeHandler()

Returns a DevModeHandler instance for the given service.

Returns:

a DevModeHandler instance

isDevModeAlreadyStarted

boolean isDevModeAlreadyStarted(VaadinContext context)

Returns whether DevModeHandler has been already started or not.

Parameters:

context - The VaadinContext, not null

Returns:

true if DevModeHandler has already been started, false - otherwise

getDevModeHandler

static Optional<DevModeHandler> getDevModeHandler(VaadinService service)

Create a DevModeHandler if factory available.

Parameters:

service - a Vaadin service

Returns:

an Optional containing a DevModeHandler instance or EMPTY if disabled