com.vaadin.flow.server.frontend

Class NodeTasks.Builder

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.

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

Modifier and Type	Method and Description
NodeTasks	build() Creates a NodeExecutor using this configuration.
NodeTasks.Builder	collectVisitedClasses(Set<String> visitedClasses) Sets a set to which the names of classes visited when finding dependencies will be collected.
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	runNpmInstall(boolean runNpmInstall) Sets whether run npm install after updating dependencies.
NodeTasks.Builder	withEmbeddableWebComponents(boolean generateEmbeddableWebComponents) Sets whether to collect and package WebComponentExporter dependencies.
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 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 true

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

collectVisitedClasses

public NodeTasks.Builder collectVisitedClasses(Set<String> visitedClasses)

Sets a set to which the names of classes visited when finding dependencies will be collected.

Parameters:

visitedClasses - a set to collect class name to, or null to not collect visited classes

Returns:

the builder, for chaining