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 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 new DevModeHandler.

      Parameters:

      classes - classes to check for npm- and js modules

      context - Vaadin 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

    • setApplicationUrl

      void setApplicationUrl(String applicationUrl)

      Sets the application URL for the given application.

      This is only called if the URL is known.

      Parameters:

      applicationUrl - the application url

    • registerShutdownCommand

      void registerShutdownCommand(Command command)

      Registers a command that will run when DevModeHandler is shut down

      Parameters:

      command - the command to run

    • 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