A B C D E F G H I L M N O P R S T V W Y

A

AnnotationValuesExtractor - Class in com.vaadin.flow.plugin.common

Collects annotation values from all classes or jars specified.

AnnotationValuesExtractor(ClassFinder) - Constructor for class com.vaadin.flow.plugin.common.AnnotationValuesExtractor

Prepares the class to extract annotations with the class finder specified.

applyTheme(Set<String>) - Method in class com.vaadin.flow.plugin.common.ThemedURLTranslator

Applies theme to the urls collection.

ArtifactData - Class in com.vaadin.flow.plugin.common

All information required to properly unpack the jar.

ArtifactData(File, String, String) - Constructor for class com.vaadin.flow.plugin.common.ArtifactData

Create a new ArtifactData.

autodetectTools(boolean) - Method in class com.vaadin.flow.plugin.common.RunnerManager.Builder

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

B

build() - Method in class com.vaadin.flow.plugin.common.RunnerManager.Builder

Creates the RunnerManager instance.

Builder(File, ProxyConfig) - Constructor for class com.vaadin.flow.plugin.common.RunnerManager.Builder

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

BuildFrontendMojo - Class in com.vaadin.flow.plugin.maven

Goal that builds the frontend bundle.

BuildFrontendMojo() - Constructor for class com.vaadin.flow.plugin.maven.BuildFrontendMojo

BundleConfigurationReader - Class in com.vaadin.flow.plugin.common

Helper class for reading the contents of a bundle configuration file.

BundleConfigurationReader(File) - Constructor for class com.vaadin.flow.plugin.common.BundleConfigurationReader

Constructs a new bundle configuration reader for reading the given file.

C

ciBuild - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

Setting this to true will run npm ci instead of npm install when using npm.

CleanFrontendMojo - Class in com.vaadin.flow.plugin.maven

Goal that cleans the frontend files to a clean state.

CleanFrontendMojo() - Constructor for class com.vaadin.flow.plugin.maven.CleanFrontendMojo

com.github.eirslett.maven.plugins.frontend.lib - package com.github.eirslett.maven.plugins.frontend.lib

com.vaadin.flow.plugin.common - package com.vaadin.flow.plugin.common

com.vaadin.flow.plugin.maven - package com.vaadin.flow.plugin.maven

com.vaadin.flow.plugin.production - package com.vaadin.flow.plugin.production

copyFrontendJavaScriptFiles(File, String, String) - Method in class com.vaadin.flow.plugin.production.ProductionModeCopyStep

Copies files from earlier specified jars and frontendWorkingDirectory, applying exclusions specified to all files.

CopyProductionFilesMojo - Class in com.vaadin.flow.plugin.maven

Goal that copies all production mode files into the CopyProductionFilesMojo.copyOutputDirectory directory.

CopyProductionFilesMojo() - Constructor for class com.vaadin.flow.plugin.maven.CopyProductionFilesMojo

copyWebApplicationFiles(File, File, String) - Method in class com.vaadin.flow.plugin.production.ProductionModeCopyStep

Copies files from earlier specified jars and frontendWorkingDirectory, applying exclusions specified to all files.

createFragmentFiles(File) - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

If bundling is enabled, creates fragment files required for the bundling, if any were configured.

createShellFile(File) - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

Creates a shell file that contains all application imports excluding the ones included into fragments (if any).

D

DefaultGulpRunnerLocal - Class in com.github.eirslett.maven.plugins.frontend.lib

Gulp runner that uses an specific configuration(paths) of node, npm, installation directory and working directory and platform.

DefaultGulpRunnerLocal(NodeExecutorConfig) - Constructor for class com.github.eirslett.maven.plugins.frontend.lib.DefaultGulpRunnerLocal

Defines and configures a DefaultGulpRunner with a specific gulp configuration.

DefaultYarnRunnerLocal - Class in com.github.eirslett.maven.plugins.frontend.lib

Yarn runner that uses an specific configuration(paths) of node, yarn, working directory and platform.

DefaultYarnRunnerLocal(YarnExecutorConfig, ProxyConfig, String) - Constructor for class com.github.eirslett.maven.plugins.frontend.lib.DefaultYarnRunnerLocal

Creates a DefaultYarnRunner with an specific configuration.

DEPENDENCIES - Static variable in class com.vaadin.flow.plugin.maven.CleanFrontendMojo

DEV_DEPENDENCIES - Static variable in class com.vaadin.flow.plugin.maven.CleanFrontendMojo

E

equals(Object) - Method in class com.vaadin.flow.plugin.common.ArtifactData

execute() - Method in class com.vaadin.flow.plugin.maven.BuildFrontendMojo

execute() - Method in class com.vaadin.flow.plugin.maven.CleanFrontendMojo

execute() - Method in class com.vaadin.flow.plugin.maven.CopyProductionFilesMojo

execute() - Method in class com.vaadin.flow.plugin.maven.MigrateMojo

execute() - Method in class com.vaadin.flow.plugin.maven.PackageForProductionMojo

execute() - Method in class com.vaadin.flow.plugin.maven.PrepareFrontendMojo

execute() - Method in class com.vaadin.flow.plugin.maven.PrepareFrontendMojo.VaildateMojo

Deprecated.

extractAnnotationValues(Map<Class<? extends Annotation>, String>) - Method in class com.vaadin.flow.plugin.common.AnnotationValuesExtractor

Extracts annotation values from the annotations.

F

FlowModeAbstractMojo - Class in com.vaadin.flow.plugin.maven

The base class of Flow Mojos in order to compute correctly the modes.

FlowModeAbstractMojo() - Constructor for class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

FlowPluginFrontendUtils - Class in com.vaadin.flow.plugin.common

Utility methods used by all goals.

Fragment - Class in com.vaadin.flow.plugin.maven

Intended to be used by Maven to specify fragments.

Fragment() - Constructor for class com.vaadin.flow.plugin.maven.Fragment

FrontendDanceMojo - Class in com.vaadin.flow.plugin.maven

This is the hidden `vaadin:dance` to clean up the frontend files.

FrontendDanceMojo() - Constructor for class com.vaadin.flow.plugin.maven.FrontendDanceMojo

FrontendDataProvider - Class in com.vaadin.flow.plugin.common

Provides necessary data for FrontendToolsManager to process project frontend files.

FrontendDataProvider(boolean, boolean, boolean, File, AnnotationValuesExtractor, File, String, Map<String, Set<String>>) - Constructor for class com.vaadin.flow.plugin.common.FrontendDataProvider

Creates the data provider.

frontendDirectory - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

A directory with project's frontend source files.

frontendResourcesDirectory - Variable in class com.vaadin.flow.plugin.maven.BuildFrontendMojo

Defines the project frontend directory from where resources should be copied from for use with webpack.

frontendToolsLocator(FrontendToolsLocator) - Method in class com.vaadin.flow.plugin.common.RunnerManager.Builder

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

FrontendToolsManager - Class in com.vaadin.flow.plugin.common

Entity to operate frontend tools to transpile files.

FrontendToolsManager(File, String, String, FrontendDataProvider, RunnerManager) - Constructor for class com.vaadin.flow.plugin.common.FrontendToolsManager

Prepares the manager.

G

generateWebComponentModules(File) - Method in class com.vaadin.flow.plugin.common.WebComponentModulesGenerator

Collects WebComponentModulesWriter class and classes that extend WebComponentExporter or WebComponentExporterFactory using inspector.

getArtifactId() - Method in class com.vaadin.flow.plugin.common.ArtifactData

Gets corresponding artifact id.

getClassFinder(MavenProject) - Static method in class com.vaadin.flow.plugin.common.FlowPluginFrontendUtils

Gets a ClassFinder for the maven project.

getDefaultGulpRunner() - Method in class com.github.eirslett.maven.plugins.frontend.lib.DefaultGulpRunnerLocal

Gets the GulpRunner of the local default gulp runner.

getDefaultYarnRunner() - Method in class com.github.eirslett.maven.plugins.frontend.lib.DefaultYarnRunnerLocal

Gets the yarnRunner.

getFileOrDirectory() - Method in class com.vaadin.flow.plugin.common.ArtifactData

Gets corresponding file or directory.

getFiles() - Method in class com.vaadin.flow.plugin.maven.Fragment

Gets the files that belong to the fragment.

getFragments() - Method in class com.vaadin.flow.plugin.common.BundleConfigurationReader

Get the fragments data from the bundle configuration specified: fragment name and a set of file paths as strings to the resources that are to be included in the final produced fragment file.

getGulpRunner() - Method in class com.vaadin.flow.plugin.common.RunnerManager

Gets the GulpRunner that will be used in the transpilation.

getInstallDirectory() - Method in class com.github.eirslett.maven.plugins.frontend.lib.NodeExecutorConfigLocal

Gets the installation directory.

getName() - Method in class com.vaadin.flow.plugin.maven.Fragment

Gets the name of a fragment.

getNodePath() - Method in class com.github.eirslett.maven.plugins.frontend.lib.NodeExecutorConfigLocal

Gets the file where node is installed.

getNodePath() - Method in class com.github.eirslett.maven.plugins.frontend.lib.YarnConfigurationLocal

Gets the file where node is installed.

getNpmPath() - Method in class com.github.eirslett.maven.plugins.frontend.lib.NodeExecutorConfigLocal

Gets the filed in which npm is installed.

getPackageName() - Method in class com.vaadin.flow.plugin.production.WebJarPackage

Gets the name of the package in the WebJar.

getPathToPackage() - Method in class com.vaadin.flow.plugin.production.WebJarPackage

Gets path to package that in the WebJar.

getPlatform() - Method in class com.github.eirslett.maven.plugins.frontend.lib.NodeExecutorConfigLocal

Get the platform in which the plugin is executed.

getPlatform() - Method in class com.github.eirslett.maven.plugins.frontend.lib.YarnConfigurationLocal

Get the platform in which the plugin is executed.

getTranslator(File, ClassPathIntrospector) - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

Gets the URL translator to rewrite URL using the theme in declared in the application.

getVersion() - Method in class com.vaadin.flow.plugin.common.ArtifactData

Gets corresponding artifact version.

getWebComponentGenerator(ClassPathIntrospector) - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

Gets web component module content generator.

getWebJar() - Method in class com.vaadin.flow.plugin.production.WebJarPackage

Gets the WebJar that holds the package.

getWorkingDirectory() - Method in class com.github.eirslett.maven.plugins.frontend.lib.NodeExecutorConfigLocal

Gets the working directory.

getWorkingDirectory() - Method in class com.github.eirslett.maven.plugins.frontend.lib.YarnConfigurationLocal

Gets the working directory.

getYarnPath() - Method in class com.github.eirslett.maven.plugins.frontend.lib.YarnConfigurationLocal

Gets the file where yarn is installed.

getYarnRunner() - Method in class com.vaadin.flow.plugin.common.RunnerManager

Gets the YarnRunner that is used to install dependencies.

H

hashCode() - Method in class com.vaadin.flow.plugin.common.ArtifactData

I

installFrontendTools(int) - Method in class com.vaadin.flow.plugin.common.FrontendToolsManager

Installs tools required for transpilation.

L

localInstallations(File, File) - Method in class com.vaadin.flow.plugin.common.RunnerManager.Builder

Sets the paths to the local installation of the tools.

M

MigrateMojo - Class in com.vaadin.flow.plugin.maven

This goal migrates project from compatibility mode to NPM mode.

MigrateMojo() - Constructor for class com.vaadin.flow.plugin.maven.MigrateMojo

N

nodeDownloadRoot - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

Download node.js from this URL.

NodeExecutorConfigLocal - Class in com.github.eirslett.maven.plugins.frontend.lib

Contains the configuration for running gulp DefaultGulpRunnerLocal.

NodeExecutorConfigLocal(File, File, File, File) - Constructor for class com.github.eirslett.maven.plugins.frontend.lib.NodeExecutorConfigLocal

Creates the configuration for a NodeExecutor.

nodeVersion - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

The node.js version to be used when node.js is installed automatically by Vaadin, for example `"v14.15.4"`.

npmRegistryUrl(String) - Method in class com.vaadin.flow.plugin.common.RunnerManager.Builder

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

O

oldLicenseChecker - Variable in class com.vaadin.flow.plugin.maven.BuildFrontendMojo

Whether to use old JavaScript license checker and disable server-side and offline features of the new license checker.

P

PackageForProductionMojo - Class in com.vaadin.flow.plugin.maven

Goal that prepares all web files from PackageForProductionMojo.transpileEs6SourceDirectory for production mode: minifies, transpiles and bundles them.

PackageForProductionMojo() - Constructor for class com.vaadin.flow.plugin.maven.PackageForProductionMojo

pnpmEnable - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

Instructs to use pnpm for installing npm frontend resources.

PrepareFrontendMojo - Class in com.vaadin.flow.plugin.maven

This goal checks that node and npm tools are installed, copies frontend resources available inside `.jar` dependencies to `node_modules`, and creates or updates `package.json` and `webpack.config.json` files.

PrepareFrontendMojo() - Constructor for class com.vaadin.flow.plugin.maven.PrepareFrontendMojo

PrepareFrontendMojo.VaildateMojo - Class in com.vaadin.flow.plugin.maven

Deprecated.

use PrepareFrontendMojo instead

productionMode - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

Whether or not we are running in productionMode.

ProductionModeCopyStep - Class in com.vaadin.flow.plugin.production

Copies specified artifacts' contents to the output folder.

ProductionModeCopyStep(Collection<ArtifactData>) - Constructor for class com.vaadin.flow.plugin.production.ProductionModeCopyStep

Fill and verify initial jar files' data.

ProductionModeCopyStep(JarContentsManager, Collection<ArtifactData>) - Constructor for class com.vaadin.flow.plugin.production.ProductionModeCopyStep

Fill and verify initial jar files' data, use custom version of JarContentsManager for the operations.

R

requireHomeNodeExec - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

Whether vaadin home node executable usage is forced.

RunnerManager - Class in com.vaadin.flow.plugin.common

The class to manage the runners for frontend tools – gulp, node and yarn.

RunnerManager.Builder - Class in com.vaadin.flow.plugin.common

The builder for creating the RunnerManager.

S

selectCorrectPackage(WebJarPackage, WebJarPackage) - Static method in class com.vaadin.flow.plugin.production.WebJarPackage

Attempts to select correct package out of two WebJar package data, resolving common WebJar issues: https://github.com/webjars/webjars/issues/1656 https://github.com/webjars/webjars/issues/1452

shouldBundle() - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

Gets the information whether should the plugin bundle the frontend files or not.

shouldHash() - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

Gets the information whether should the plugin rename the output files by adding a hash fragment.

shouldMinify() - Method in class com.vaadin.flow.plugin.common.FrontendDataProvider

Gets the information whether should the plugin minify the output files or not.

T

ThemedURLTranslator - Class in com.vaadin.flow.plugin.common

Translates the URLs according to the theme discovered in the project.

ThemedURLTranslator(Function<String, File>, ClassPathIntrospector) - Constructor for class com.vaadin.flow.plugin.common.ThemedURLTranslator

Creates a new translator instance using the provided fileFactory which produces the File on the filesystem by the URL and some otherIntrospector to use its reflections tools.

toString() - Method in class com.vaadin.flow.plugin.common.ArtifactData

toString() - Method in class com.vaadin.flow.plugin.maven.Fragment

TranspilationStep - Class in com.vaadin.flow.plugin.production

Transpiles artifacts in the specified directory.

TranspilationStep(FrontendToolsManager, int) - Constructor for class com.vaadin.flow.plugin.production.TranspilationStep

Prepares the step.

transpileFiles(File, File, boolean) - Method in class com.vaadin.flow.plugin.common.FrontendToolsManager

Transpiles files in the directory provided, copying them to the working directory.

transpileFiles(File, File, boolean) - Method in class com.vaadin.flow.plugin.production.TranspilationStep

Transpiles the files from source directory into the output directory.

V

VAADIN - Static variable in class com.vaadin.flow.plugin.maven.CleanFrontendMojo

VaildateMojo() - Constructor for class com.vaadin.flow.plugin.maven.PrepareFrontendMojo.VaildateMojo

Deprecated.

versionsToDownload(String, String) - Method in class com.vaadin.flow.plugin.common.RunnerManager.Builder

Sets the versions of the tools to download, if no local tools are installed.

W

WebComponentModulesGenerator - Class in com.vaadin.flow.plugin.common

Generates embeddable web component files in bower production mode, hiding the complexity caused by using a different class loader.

WebComponentModulesGenerator(ClassPathIntrospector) - Constructor for class com.vaadin.flow.plugin.common.WebComponentModulesGenerator

Creates a new instances and stores the introspector to be used for locating WebComponentModulesWriter class and WebComponentExporter/WebComponentExporterFactory implementations.

WebJarPackage - Class in com.vaadin.flow.plugin.production

Wrapper around ArtifactData that holds information about a package located in the corresponding WebJar.

WebJarPackage(ArtifactData, String, String) - Constructor for class com.vaadin.flow.plugin.production.WebJarPackage

Creates new wrapper instance.

webpackOutputDirectory - Variable in class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

The folder where webpack should output index.js and other generated files.

Y

YarnConfigurationLocal - Class in com.github.eirslett.maven.plugins.frontend.lib

Yarn configuration needed for its running.

YarnConfigurationLocal(File, File, File) - Constructor for class com.github.eirslett.maven.plugins.frontend.lib.YarnConfigurationLocal

Creates the configuration for a YarnExecutor.

A B C D E F G H I L M N O P R S T V W Y