NodeTasks.Builder (Vaadin Platform (vaadin-platform-javadoc) 14.12.5 API)

java.lang.Object
- com.vaadin.flow.server.frontend.NodeTasks.Builder

All Implemented Interfaces:

Serializable

Enclosing class:

NodeTasks
```
public static class NodeTasks.Builder
extends Object
implements Serializable
```
Build a NodeExecutor instance.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

File generatedFolder
Directory where generated files are written.

File npmFolder
Directory for for npm and folders and files.

Fields
Modifier and Type	Field and Description
`File`	`generatedFolder` Directory where generated files are written.
`File`	`npmFolder` Directory for for npm and folders and files.

Constructor Summary

Constructors
Constructor and Description
`Builder(ClassFinder classFinder, File npmFolder)` Create a builder instance given an specific npm folder.
`Builder(ClassFinder classFinder, File npmFolder, File generatedPath)` Create a builder instance with custom npmFolder and generatedPath
`Builder(ClassFinder classFinder, File npmFolder, File generatedPath, File frontendDirectory)` Create a builder instance with all parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeTasks`	`build()` Creates a `NodeExecutor` using this configuration.
`NodeTasks.Builder`	`copyLocalResources(File frontendResourcesDirectory)` Set local frontend files to be copied from given folder.
`NodeTasks.Builder`	`copyResources(Set<File> jars)` Sets whether copy resources from classpath to the `node_modules` folder as they are available for webpack build.
`NodeTasks.Builder`	`createMissingPackageJson(boolean create)` Sets whether to create the package file if missing.
`NodeTasks.Builder`	`enableImportsUpdate(boolean enableImportsUpdate)` Sets whether to enable imports file update.
`NodeTasks.Builder`	`enablePackagesUpdate(boolean enablePackagesUpdate)` Sets whether to enable packages and webpack file updates.
`NodeTasks.Builder`	`enablePnpm(boolean enable)` Enables pnpm tool.
`NodeTasks.Builder`	`populateTokenFileData(elemental.json.JsonObject object)` Fill token file data into the provided `object`.
`NodeTasks.Builder`	`runNpmInstall(boolean runNpmInstall)` Sets whether run `npm install` after updating dependencies.
`NodeTasks.Builder`	`useByteCodeScanner(boolean byteCodeScanner)` Sets frontend scanner strategy: byte code scanning strategy is used if `byteCodeScanner` is `true`, full classpath scanner strategy is used otherwise (by default).
`NodeTasks.Builder`	`withAdditionalFrontendModules(List<String> frontendModules)` JS modules to be included in the webpack bundle, in addition to those discovered by class scanning.
`NodeTasks.Builder`	`withCiBuild(boolean ciBuild)` Enables ci build.
`NodeTasks.Builder`	`withEmbeddableWebComponents(boolean generateEmbeddableWebComponents)` Sets whether to collect and package `WebComponentExporter` dependencies.
`NodeTasks.Builder`	`withHomeNodeExecRequired(boolean requireHomeNodeExec)` Requires node executable to be installed in vaadin home folder.
`NodeTasks.Builder`	`withNodeDownloadRoot(URI nodeDownloadRoot)` Sets the download node.js URL.
`NodeTasks.Builder`	`withNodeVersion(String nodeVersion)` Sets the node.js version to be used when node.js is installed automatically by Vaadin, for example `"v14.15.4"`.
`NodeTasks.Builder`	`withOldLicenseChecker(boolean enable)` Falls back to the old license checking and disables server-side and offline new license checking features.
`NodeTasks.Builder`	`withProductionMode(boolean productionMode)` Sets the production mode.
`NodeTasks.Builder`	`withTokenFile(File tokenFile)` Sets the token file (flow-build-info.json) path.
`NodeTasks.Builder`	`withWebpack(File webpackOutputDirectory, String webpackTemplate, String webpackGeneratedTemplate)` Sets the webpack related properties.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - npmFolder
```
public final File npmFolder
```
    Directory for for npm and folders and files.
  - generatedFolder
```
public final File generatedFolder
```
    Directory where generated files are written.
- Constructor Detail
  - Builder
```
public Builder(ClassFinder classFinder,
               File npmFolder)
```
    Create a builder instance given an specific npm folder.
    
    Parameters:
    
    classFinder - a class finder
    
    npmFolder - folder with the `package.json` file
  - Builder
```
public Builder(ClassFinder classFinder,
               File npmFolder,
               File generatedPath)
```
    Create a builder instance with custom npmFolder and generatedPath
    
    Parameters:
    
    classFinder - a class finder
    
    npmFolder - folder with the `package.json` file
    
    generatedPath - folder where flow generated files will be placed.
  - Builder
```
public Builder(ClassFinder classFinder,
               File npmFolder,
               File generatedPath,
               File frontendDirectory)
```
    Create a builder instance with all parameters.
    
    Parameters:
    
    classFinder - a class finder
    
    npmFolder - folder with the `package.json` file
    
    generatedPath - folder where flow generated files will be placed.
    
    frontendDirectory - a directory with project's frontend files
- Method Detail
  - build
```
public NodeTasks build()
```
    Creates a NodeExecutor using this configuration.
    
    Returns:
    
    a NodeExecutor instance
  - withWebpack
```
public NodeTasks.Builder withWebpack(File webpackOutputDirectory,
                                     String webpackTemplate,
                                     String webpackGeneratedTemplate)
```
    Sets the webpack related properties.
    
    Parameters:
    
    webpackOutputDirectory - the directory to set for webpack to output its build results.
    
    webpackTemplate - name of the webpack resource to be used as template when creating the webpack.config.js file.
    
    webpackGeneratedTemplate - name of the webpack resource to be used as template when creating the webpack.generated.js file.
    
    Returns:
    
    this builder
  - enablePackagesUpdate
```
public NodeTasks.Builder enablePackagesUpdate(boolean enablePackagesUpdate)
```
    Sets whether to enable packages and webpack file updates. Default is true.
    
    Parameters:
    
    enablePackagesUpdate - true to enable packages and webpack update, otherwise false
    
    Returns:
    
    this builder
  - enableImportsUpdate
```
public NodeTasks.Builder enableImportsUpdate(boolean enableImportsUpdate)
```
    Sets whether to enable imports file update. Default is false. This will also enable creation of missing package files if set to true.
    
    Parameters:
    
    enableImportsUpdate - true to enable imports file update, otherwise false
    
    Returns:
    
    this builder
  - runNpmInstall
```
public NodeTasks.Builder runNpmInstall(boolean runNpmInstall)
```
    Sets whether run npm install after updating dependencies.
    
    Parameters:
    
    runNpmInstall - run npm install. Default is false
    
    Returns:
    
    the builder
  - copyResources
```
public NodeTasks.Builder copyResources(Set<File> jars)
```
    Sets whether copy resources from classpath to the `node_modules` folder as they are available for webpack build.
    
    Parameters:
    
    jars - set of class nodes to be visited. Not null
    
    Returns:
    
    the builder
  - withEmbeddableWebComponents
```
public NodeTasks.Builder withEmbeddableWebComponents(boolean generateEmbeddableWebComponents)
```
    Sets whether to collect and package WebComponentExporter dependencies.
    
    Parameters:
    
    generateEmbeddableWebComponents - collect dependencies. Default is true
    
    Returns:
    
    the builder
  - createMissingPackageJson
```
public NodeTasks.Builder createMissingPackageJson(boolean create)
```
    Sets whether to create the package file if missing.
    
    Parameters:
    
    create - create the package
    
    Returns:
    
    the builder
  - copyLocalResources
```
public NodeTasks.Builder copyLocalResources(File frontendResourcesDirectory)
```
    Set local frontend files to be copied from given folder.
    
    Parameters:
    
    frontendResourcesDirectory - folder to copy local frontend files from
    
    Returns:
    
    the builder, for chaining
  - useByteCodeScanner
```
public NodeTasks.Builder useByteCodeScanner(boolean byteCodeScanner)
```
    Sets frontend scanner strategy: byte code scanning strategy is used if byteCodeScanner is true, full classpath scanner strategy is used otherwise (by default).
    
    Parameters:
    
    byteCodeScanner - if true then byte code scanner is used, full scanner is used otherwise (by default).
    
    Returns:
    
    the builder, for chaining
  - populateTokenFileData
```
public NodeTasks.Builder populateTokenFileData(elemental.json.JsonObject object)
```
    Fill token file data into the provided object.
    
    Parameters:
    
    object - the object to fill with token file data
    
    Returns:
    
    the builder, for chaining
  - withTokenFile
```
public NodeTasks.Builder withTokenFile(File tokenFile)
```
    Sets the token file (flow-build-info.json) path.
    
    Parameters:
    
    tokenFile - token file path
    
    Returns:
    
    the builder, for chaining
  - enablePnpm
```
public NodeTasks.Builder enablePnpm(boolean enable)
```
    Enables pnpm tool.
    "pnpm" will be used instead of "npm".
    
    Parameters:
    
    enable - enables pnpm.
    
    Returns:
    
    the builder, for chaining
  - withHomeNodeExecRequired
```
public NodeTasks.Builder withHomeNodeExecRequired(boolean requireHomeNodeExec)
```
    Requires node executable to be installed in vaadin home folder.
    
    Parameters:
    
    requireHomeNodeExec - requires vaadin home node exec
    
    Returns:
    
    the builder, for chaining
  - withAdditionalFrontendModules
```
public NodeTasks.Builder withAdditionalFrontendModules(List<String> frontendModules)
```
    JS modules to be included in the webpack bundle, in addition to those discovered by class scanning. Currently only the development mode gizmo module (@vaadin/flow-frontend/VaadinDevModeGizmo.js) is added via this mechanism.
    
    Parameters:
    
    frontendModules - List of module names.
    
    Returns:
    
    the builder, for chaining
  - withNodeVersion
```
public NodeTasks.Builder withNodeVersion(String nodeVersion)
```
    Sets the node.js version to be used when node.js is installed automatically by Vaadin, for example "v14.15.4". Defaults to .
    
    Parameters:
    
    nodeVersion - the new node version to download, not null.
    
    Returns:
    
    the builder, for chaining
  - withNodeDownloadRoot
```
public NodeTasks.Builder withNodeDownloadRoot(URI nodeDownloadRoot)
```
    Sets the download node.js URL. Handy in heavily firewalled corporate environments where the node.js download can be provided from an intranet mirror. Defaults to NodeInstaller.DEFAULT_NODEJS_DOWNLOAD_ROOT.
    
    Parameters:
    
    nodeDownloadRoot - the new download URL to set, not null.
    
    Returns:
    
    the builder, for chaining
  - withProductionMode
```
public NodeTasks.Builder withProductionMode(boolean productionMode)
```
    Sets the production mode.
    
    Parameters:
    
    productionMode - true to enable production mode, otherwise false
    
    Returns:
    
    this builder
  - withOldLicenseChecker
```
public NodeTasks.Builder withOldLicenseChecker(boolean enable)
```
    Falls back to the old license checking and disables server-side and offline new license checking features.
    
    Parameters:
    
    enable - falls back to the old license checker if true.
    
    Returns:
    
    the builder, for chaining
  - withCiBuild
```
public NodeTasks.Builder withCiBuild(boolean ciBuild)
```
    Enables ci build.
    "npm ci" will be used instead of "npm install". "--frozen-lockfile" will be used if pnpm is used instead of npm.
    
    Parameters:
    
    ciBuild - true to enable ci build
    
    Returns:
    
    the builder, for chaining

Class NodeTasks.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

npmFolder

generatedFolder

Constructor Detail

Builder

Builder

Builder

Method Detail

build

withWebpack

enablePackagesUpdate

enableImportsUpdate

runNpmInstall

copyResources

withEmbeddableWebComponents

createMissingPackageJson

copyLocalResources

useByteCodeScanner

populateTokenFileData

withTokenFile

enablePnpm

withHomeNodeExecRequired

withAdditionalFrontendModules

withNodeVersion

withNodeDownloadRoot

withProductionMode

withOldLicenseChecker

withCiBuild