com.vaadin.flow.migration

Class MigrationConfiguration.Builder

java.lang.Object

com.vaadin.flow.migration.MigrationConfiguration.Builder

Enclosing class:

MigrationConfiguration

public static class MigrationConfiguration.Builder
extends Object

A builder for MigrationConfiguration. Allows to set all required parameters via setters fluent API.

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
Builder(File baseDir) Creates a new instance of the builded with provided baseDir.

Method Summary

Modifier and Type	Method and Description
MigrationConfiguration	build() Builds the immutable configuration based on the builder.
MigrationConfiguration.Builder	setAnnotationRewriteStrategy(AnnotationsRewriteStrategy strategy) Sets the annotation rewrite strategy.
MigrationConfiguration.Builder	setClassFinder(ClassFinder finder) Sets the class finder instance.
MigrationConfiguration.Builder	setCompiledClassDirectory(File classDirectory) Sets java binary (compiled) classes directory.
MigrationConfiguration.Builder	setIgnoreModulizerErrors(boolean ignoreModulizerErrors) Sets whether the build should be considered successful even if there are Modulizer errors.
MigrationConfiguration.Builder	setJavaSourceRoots(File[] sourceRoots) Sets java source roots.
MigrationConfiguration.Builder	setKeepOriginalFiles(boolean keepOriginal) Sets whether the original resources should be preserved.
void	setPnpmEnabled(boolean enable) Enables "pnpm" tool so that it will be used instead of "npm" to install frontend resources.
MigrationConfiguration.Builder	setResourceDirectories(File[] resourceDirs) Sets the resource files directories.
MigrationConfiguration.Builder	setTargetDirectory(File targetDir) Sets the target directory where the resource files will be stored after the migration.
MigrationConfiguration.Builder	setTemporaryMigrationFolder(File file) Sets temporary migration folder where the migration happens.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(File baseDir)

Creates a new instance of the builded with provided baseDir.

Parameters:

baseDir - base project directory

Method Detail

setTemporaryMigrationFolder

public MigrationConfiguration.Builder setTemporaryMigrationFolder(File file)

Sets temporary migration folder where the migration happens.

The folder value is not required. It it's not set then temporary folder will be used. This folder will be removed once the migration happens regardless of result.

Parameters:

file - the migration folder

Returns:

this builder

setResourceDirectories

public MigrationConfiguration.Builder setResourceDirectories(File[] resourceDirs)

Sets the resource files directories.

There can be several resource roots. They contains HTML tempate files and stylesheet files. The hierarchical structure will be transfered into the target directory (see setTargetDirectory(File) as is (except "frontend" directory whose files and subdirs are moved ignoring the "frontend" dir).

Parameters:

resourceDirs - resource roots

Returns:

this builder

setTargetDirectory

public MigrationConfiguration.Builder setTargetDirectory(File targetDir)

Sets the target directory where the resource files will be stored after the migration.

This directory is usually is "frontend" folder inside base dir

Parameters:

targetDir - the target directory

Returns:

this builder

setKeepOriginalFiles

public MigrationConfiguration.Builder setKeepOriginalFiles(boolean keepOriginal)

Sets whether the original resources should be preserved.

By default the original resources are removed if there were no errors during migration.

Parameters:

keepOriginal - whether the original resources should be preserved

Returns:

this builder

setIgnoreModulizerErrors

public MigrationConfiguration.Builder setIgnoreModulizerErrors(boolean ignoreModulizerErrors)

Sets whether the build should be considered successful even if there are Modulizer errors.

Modulizer is an external tool which is used internally for converting resource files. Modulizer process exit status may be non zero even if all files have been converted correctly. By default the exit status code is ignored.

Parameters:

ignoreModulizerErrors - whether the tool should fail is Modulizer fails

Returns:

this builder

setClassFinder

public MigrationConfiguration.Builder setClassFinder(ClassFinder finder)

Sets the class finder instance.

Parameters:

finder - a class finder

Returns:

this builder

setJavaSourceRoots

public MigrationConfiguration.Builder setJavaSourceRoots(File[] sourceRoots)

Sets java source roots.

Java source roots contain java files which should be rewritten to use JsModule annotation instead of HtmlImport and StyleSheet.

Parameters:

sourceRoots - java source roots

Returns:

this builder

setCompiledClassDirectory

public MigrationConfiguration.Builder setCompiledClassDirectory(File classDirectory)

Sets java binary (compiled) classes directory.

The java files from source roots (setJavaSourceRoots(File[]) must be compiled when the migration is done into this directory.

Parameters:

classDirectory - compiled java classes directory

Returns:

this builder

setAnnotationRewriteStrategy

public MigrationConfiguration.Builder setAnnotationRewriteStrategy(AnnotationsRewriteStrategy strategy)

Sets the annotation rewrite strategy.

This strategy is used to control annotation ( HtmlImport and StyleSheet rewrite logic. By default the annotation are always rewritten regardless of conversation status.

Parameters:

strategy - the annotation rewrite strategy

Returns:

this builder

setPnpmEnabled

public void setPnpmEnabled(boolean enable)

Enables "pnpm" tool so that it will be used instead of "npm" to install frontend resources.

Parameters:

enable - enable pnpm

build

public MigrationConfiguration build()

Builds the immutable configuration based on the builder.

Returns:

the resulting configuration