com.vaadin.flow.plugin.common

Class RunnerManager.Builder

java.lang.Object

com.vaadin.flow.plugin.common.RunnerManager.Builder

Enclosing class:

RunnerManager

public static class RunnerManager.Builder
extends Object

The builder for creating the RunnerManager.

Constructor Summary

Constructors

Constructor and Description
Builder(File workingDirectory, com.github.eirslett.maven.plugins.frontend.lib.ProxyConfig proxyConfig) Create the builder with common configuration for all the tools provided.

Method Summary

Modifier and Type	Method and Description
RunnerManager.Builder	autodetectTools(boolean autodetectTools) Enables or disables local tool detection, the default value is false.
RunnerManager	build() Creates the RunnerManager instance.
RunnerManager.Builder	frontendToolsLocator(com.vaadin.flow.server.frontend.FrontendToolsLocator toolsLocator) Sets the custom FrontendToolsLocator to look for locally installed tools and verify that they are working.
RunnerManager.Builder	localInstallations(File nodePath, File yarnPath) Sets the paths to the local installation of the tools.
RunnerManager.Builder	npmRegistryUrl(String npmRegistryUrl) Sets the custom registry url to be used when running yarn.
RunnerManager.Builder	versionsToDownload(String nodeVersion, String yarnVersion) Sets the versions of the tools to download, if no local tools are installed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(File workingDirectory,
               com.github.eirslett.maven.plugins.frontend.lib.ProxyConfig proxyConfig)

Create the builder with common configuration for all the tools provided.

Parameters:

workingDirectory - the directory to install and run the tools into

proxyConfig - the configuration used when installing and running the tools

Method Detail

versionsToDownload

public RunnerManager.Builder versionsToDownload(String nodeVersion,
                                                String yarnVersion)

Sets the versions of the tools to download, if no local tools are installed. The versions specified are used for downloading the tools only.

Parameters:

nodeVersion - node version to download, if the local installation is missing

yarnVersion - yarn version to download, if the local installation is missing

Returns:

current builder instance to chain calls

localInstallations

public RunnerManager.Builder localInstallations(File nodePath,
                                                File yarnPath)

Sets the paths to the local installation of the tools. If both tool paths are specified and both tools work, no download attempts with versions specified in versionsToDownload(String, String)} are made.

Parameters:

nodePath - the path to locally installed node or null if the tool is absent

yarnPath - the path to locally installed yarn or null if the tool is absent

Returns:

current builder instance to chain calls

npmRegistryUrl

public RunnerManager.Builder npmRegistryUrl(String npmRegistryUrl)

Sets the custom registry url to be used when running yarn.

Parameters:

npmRegistryUrl - the custom URL to NPM registry or null for default registry

Returns:

current builder instance to chain calls

frontendToolsLocator

public RunnerManager.Builder frontendToolsLocator(com.vaadin.flow.server.frontend.FrontendToolsLocator toolsLocator)

Sets the custom FrontendToolsLocator to look for locally installed tools and verify that they are working.

Parameters:

toolsLocator - local frontend tools locator, not null

Returns:

current builder instance to chain calls

autodetectTools

public RunnerManager.Builder autodetectTools(boolean autodetectTools)

Enables or disables local tool detection, the default value is false.

Parameters:

autodetectTools - when true, the manager searches the current system for installed tools

Returns:

current builder instance to chain calls

build

public RunnerManager build()

Creates the RunnerManager instance. If there is no data on any tool specified (no local path, no version to download and automatic detection is turned off), an exception is thrown.

Returns:

the RunnerManager instance

Throws:

IllegalStateException - if there is no data on any tool (node, yarn) is specified that allows to locate it