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 TypeMethodDescriptionReturns aDevModeHandler
instance for the givenservice
.static Optional<DevModeHandler>
getDevModeHandler
(VaadinContext context) Gets theDevModeHandler
.static Optional<DevModeHandler>
getDevModeHandler
(VaadinService service) Gets theDevModeHandler
.Class<?>[]
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 newDevModeHandler
.void
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
Stops a runningDevModeHandler
.
-
Method Details
-
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 newDevModeHandler
.- Parameters:
classes
- classes to check for npm- and js modulescontext
- servlet context we are running in- Throws:
VaadinInitializerException
- if dev mode can't be initialized
-
stopDevModeHandler
void stopDevModeHandler()Stops a runningDevModeHandler
. -
setDevModeHandler
Defines the handler to use with this manager.- Parameters:
devModeHandler
- the dev mode handler to use
-
getDevModeHandler
DevModeHandler getDevModeHandler()Returns aDevModeHandler
instance for the givenservice
.- Returns:
- a
DevModeHandler
instance
-
launchBrowserInDevelopmentMode
Opens the given application URL in a browser if the application is running in development mode.- Parameters:
url
- the url to open
-
getDevModeHandler
Gets theDevModeHandler
.- Parameters:
service
- a Vaadin service- Returns:
- an
Optional
containing aDevModeHandler
instance orEMPTY
if disabled
-
getDevModeHandler
Gets theDevModeHandler
.- Parameters:
context
- the Vaadin context- Returns:
- an
Optional
containing aDevModeHandler
instance orEMPTY
if disabled
-