Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractFileGeneratorFallibleCommand - Class in com.vaadin.flow.server.frontend
-
A base class for commands providing helpers for common file generation actions.
- AbstractFileGeneratorFallibleCommand() - Constructor for class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
- AbstractTaskClientGenerator - Class in com.vaadin.flow.server.frontend
-
Abstract class for generating client files.
- AbstractTaskClientGenerator() - Constructor for class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
- ACCEPT_MISSING_SHA - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- addCssLines(Collection<String>, CssData, int) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- addLines(Collection<String>, String) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- addValues(Map<String, List<String>>, String, List<String>) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- APP_SHELL - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
- APP_SHELL - Static variable in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- APPLICATION_META_INF_RESOURCES - Static variable in class com.vaadin.flow.server.frontend.TaskUpdateThemeImport
- APPLICATION_STATIC_RESOURCES - Static variable in class com.vaadin.flow.server.frontend.TaskUpdateThemeImport
- ArchiveExtractionException - Exception Class in com.vaadin.frontendtools.installer
-
Exception indicating a failure during extraction of an archive file.
- ArchiveExtractionException(String) - Constructor for exception class com.vaadin.frontendtools.installer.ArchiveExtractionException
-
Exception with message.
- ArchiveExtractionException(String, Throwable) - Constructor for exception class com.vaadin.frontendtools.installer.ArchiveExtractionException
-
Exceptioon with message and cause.
- ArchiveExtractor - Interface in com.vaadin.frontendtools.installer
-
Handle extracting file archives.
B
- BundleBuildUtils - Class in com.vaadin.flow.server.frontend
- BundleBuildUtils() - Constructor for class com.vaadin.flow.server.frontend.BundleBuildUtils
- BundleValidationUtil - Class in com.vaadin.flow.server.frontend
-
Bundle handling methods.
- BundleValidationUtil() - Constructor for class com.vaadin.flow.server.frontend.BundleValidationUtil
C
- CachedClassFinder(ClassFinder) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
-
It uses specified classFinder and caches scanned annotation.
- calculateHash(String) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- ChunkInfo - Class in com.vaadin.flow.server.frontend.scanner
-
Identifier for a chunk or part of the JS bundle.
- ChunkInfo(EntryPointType, String, List<String>, boolean) - Constructor for class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- CLASS_PACKAGE - Static variable in class com.vaadin.flow.server.frontend.TaskGenerateReactFiles
- ClassFinder - Interface in com.vaadin.flow.server.frontend.scanner
-
Interface for annotated and subclass class searches.
- ClassFinder.CachedClassFinder - Class in com.vaadin.flow.server.frontend.scanner
-
Implementation that proxy and cache a real
ClassFinder. - ClassFinder.DefaultClassFinder - Class in com.vaadin.flow.server.frontend.scanner
-
Implementation that searches for annotated classes or subclasses in a list of classes.
- ClassInfo - Class in com.vaadin.flow.server.frontend.scanner
-
Holds information about a class and its frontend dependencies.
- ClassInfo(String) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassInfo
- com.vaadin.flow.server.frontend - package com.vaadin.flow.server.frontend
- com.vaadin.flow.server.frontend.installer - package com.vaadin.flow.server.frontend.installer
- com.vaadin.flow.server.frontend.scanner - package com.vaadin.flow.server.frontend.scanner
- com.vaadin.frontendtools.installer - package com.vaadin.frontendtools.installer
- commandLine() - Method in record class com.vaadin.flow.server.frontend.NodeTasks.NodeTasksLockInfo
-
Returns the value of the
commandLinerecord component. - compressBundle(File, File) - Static method in class com.vaadin.flow.server.frontend.ProdBundleUtils
-
Compress the prod bundle at give location into src/main/bundles.
- containsPath(File, String) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
-
Checks if a jar file contains a path specified (case sensitive).
- copyAssets() - Method in class com.vaadin.flow.server.frontend.Options
-
Get if npm assets should be copied for this Options execution.
- copyFilesFromJarTrimmingBasePath(File, String, File, String...) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
-
Copies files from the jar file to the output directory.
- copyIncludedFilesFromJarTrimmingBasePath(File, String, File, String...) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
-
Copies files matching the inclusion filters from the jar file to the output directory.
- copyIncludedFilesFromJarTrimmingBasePath(File, String, File, Collection<String>, String...) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
-
Copies files matching the inclusion filters, but not the exclusion filters, from the jar file to the output directory.
- copyLocalResources(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Set local frontend files to be copied from given folder.
- copyPackageLockFromBundle(Options) - Static method in class com.vaadin.flow.server.frontend.BundleBuildUtils
-
Copy package-lock.json/.yaml file from existing dev-bundle for building new bundle.
- copyResources(Set<File>) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether copy resources from classpath to the appropriate npm package folder so as they are available for frontend build.
- createMissingPackageJson(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to create the package file if missing.
- createScanner(boolean, ClassFinder, boolean, FeatureFlags, boolean) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner.FrontendDependenciesScannerFactory
-
Produces scanner implementation based on
allDependenciesScanvalue. - createTaskGenerateEndpoint(Options) - Method in interface com.vaadin.flow.server.frontend.EndpointGeneratorTaskFactory
-
Create a task for generating TS files based.
- createTaskGenerateOpenAPI(Options) - Method in interface com.vaadin.flow.server.frontend.EndpointGeneratorTaskFactory
-
Create a task for generating OpenAPI spec.
- CssData - Class in com.vaadin.flow.server.frontend.scanner
-
A container for CssImport information when scanning the class path.
- CssData() - Constructor for class com.vaadin.flow.server.frontend.scanner.CssData
- CssData(String, String, String, String) - Constructor for class com.vaadin.flow.server.frontend.scanner.CssData
- CvdlProducts - Class in com.vaadin.flow.server.frontend
-
Utilities for commercial product handling.
- CvdlProducts() - Constructor for class com.vaadin.flow.server.frontend.CvdlProducts
D
- DEFAULT_NODE_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
-
This is the version that is installed if there is no node installed or the installed version is older than
FrontendTools.SUPPORTED_NODE_VERSION, i.e. - DEFAULT_NODEJS_DOWNLOAD_ROOT - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- DEFAULT_NPM_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
-
This is the version shipped with the default Node version.
- DEFAULT_PNPM_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
- DefaultArchiveExtractor - Class in com.vaadin.frontendtools.installer
-
Default implementation for file archive extraction.
- DefaultArchiveExtractor() - Constructor for class com.vaadin.frontendtools.installer.DefaultArchiveExtractor
- DefaultClassFinder(ClassLoader, Class<?>...) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
-
ClassFinder using a specified
ClassLoaderto load classes and a list of classes where to look for annotations or subclasses. - DefaultClassFinder(Set<Class<?>>) - Constructor for class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
-
It uses current classloader for getting resources or loading classes.
- DefaultFileDownloader - Class in com.vaadin.flow.server.frontend.installer
-
Default file downloader implementation.
- DefaultFileDownloader(ProxyConfig) - Constructor for class com.vaadin.flow.server.frontend.installer.DefaultFileDownloader
-
Construct file downloader with given proxy configuration.
- DEP_NAME_FLOW_DEPS - Static variable in class com.vaadin.flow.server.frontend.NodeUpdater
-
Deprecated.
- DEP_NAME_FLOW_JARS - Static variable in class com.vaadin.flow.server.frontend.NodeUpdater
-
Deprecated.
- DEV_SETTINGS_FILE - Static variable in class com.vaadin.flow.server.frontend.TaskUpdateSettingsFile
- download(URI, File, String, String, FileDownloader.ProgressListener) - Method in class com.vaadin.flow.server.frontend.installer.DefaultFileDownloader
- download(URI, File, String, String, FileDownloader.ProgressListener) - Method in interface com.vaadin.flow.server.frontend.installer.FileDownloader
-
Download to destination from url using username and password.
- DownloadException - Exception Class in com.vaadin.flow.server.frontend.installer
-
Exception indicating a failure during file download.
- DownloadException(String) - Constructor for exception class com.vaadin.flow.server.frontend.installer.DownloadException
-
Exceptioon with message.
E
- enableImportsUpdate(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to enable imports file update.
- enablePackagesUpdate(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to enable packages and frontend file updates.
- EndpointGeneratorTaskFactory - Interface in com.vaadin.flow.server.frontend
-
A factory for creating Vaadin Endpoint generator tasks.
- EntryPointData - Class in com.vaadin.flow.server.frontend.scanner
-
A simple container with the information related to an application entry point, i.e. those classes annotated with the
Routeannotation, extendingWebComponentExporterand a bunch of more internal classes. - EntryPointType - Enum Class in com.vaadin.flow.server.frontend.scanner
-
The type of an entry point (scanned for frontend dependencies).
- equals(Object) - Method in record class com.vaadin.flow.server.frontend.NodeTasks.NodeTasksLockInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- equals(Object) - Method in class com.vaadin.flow.server.frontend.scanner.CssData
- ERROR_INVALID_LOAD_DEPENDENCIES_ANNOTATION - Static variable in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- ERROR_INVALID_PWA_ANNOTATION - Static variable in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- exclude(Map<String, String>) - Method in class com.vaadin.flow.server.frontend.ExclusionFilter
-
Exclude dependencies from the given map based on the pinned npm versions files, and dependencies that are part of a package Flow manages the version of.
- ExclusionFilter - Class in com.vaadin.flow.server.frontend
-
Excludes dependencies listed in an "exclusions" array of a pinned npm versions file from a package.json.
- ExclusionFilter(ClassFinder, boolean) - Constructor for class com.vaadin.flow.server.frontend.ExclusionFilter
-
Create a new exclusion filter.
- ExclusionFilter(ClassFinder, boolean, boolean) - Constructor for class com.vaadin.flow.server.frontend.ExclusionFilter
-
Create a new exclusion filter.
- execute() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
- execute() - Method in interface com.vaadin.flow.server.frontend.FallibleCommand
-
Runs the given command.
- execute() - Method in class com.vaadin.flow.server.frontend.NodeTasks
- execute() - Method in class com.vaadin.flow.server.frontend.TaskCleanFrontendFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskCompressStaticResources
- execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyFrontendFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyLocalFrontendFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyNpmAssetsFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskCopyTemplateFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
- execute() - Method in class com.vaadin.flow.server.frontend.TaskGeneratePackageJson
- execute() - Method in class com.vaadin.flow.server.frontend.TaskGeneratePWAIcons
- execute() - Method in class com.vaadin.flow.server.frontend.TaskGenerateReactFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
- execute() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
- execute() - Method in class com.vaadin.flow.server.frontend.TaskInstallFrontendBuildPlugins
- execute() - Method in class com.vaadin.flow.server.frontend.TaskPrepareProdBundle
- execute() - Method in class com.vaadin.flow.server.frontend.TaskProcessStylesheetCss
- execute() - Method in class com.vaadin.flow.server.frontend.TaskRemoveOldFrontendGeneratedFiles
- execute() - Method in class com.vaadin.flow.server.frontend.TaskRunDevBundleBuild
- execute() - Method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall
- execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateImports
- execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateOldIndexTs
- execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdatePackages
- execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateSettingsFile
- execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateThemeImport
- execute() - Method in class com.vaadin.flow.server.frontend.TaskUpdateVite
- execute() - Method in class com.vaadin.flow.server.frontend.TaskWriteGeneratedFilesList
- ExecutionFailedException - Exception Class in com.vaadin.flow.server.frontend
-
Thrown by
FallibleCommandif it's unable to complete its execution. - ExecutionFailedException() - Constructor for exception class com.vaadin.flow.server.frontend.ExecutionFailedException
-
Creates a new exception instance.
- ExecutionFailedException(String) - Constructor for exception class com.vaadin.flow.server.frontend.ExecutionFailedException
-
Creates a new exception instance with the given
message. - ExecutionFailedException(String, Throwable) - Constructor for exception class com.vaadin.flow.server.frontend.ExecutionFailedException
-
Creates a new exception instance with the given
messageandcause. - ExecutionFailedException(Throwable) - Constructor for exception class com.vaadin.flow.server.frontend.ExecutionFailedException
-
Creates a new exception instance with the given
cause. - exportedWebComponents(JsonNode, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- extract(File, File) - Method in interface com.vaadin.frontendtools.installer.ArchiveExtractor
-
Extract archive contents to given destination.
- extract(File, File) - Method in class com.vaadin.frontendtools.installer.DefaultArchiveExtractor
F
- FallibleCommand - Interface in com.vaadin.flow.server.frontend
-
A generic command which may fail.
- FileDownloader - Interface in com.vaadin.flow.server.frontend.installer
-
Handle file download from given url to target destination.
- FileDownloader.ProgressListener - Interface in com.vaadin.flow.server.frontend.installer
- findBundleStatsJson(File, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.ProdBundleUtils
-
Get the stats.json for the application specific production bundle or from the default bundle if it exists.
- findFiles(File, String, String) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
-
Finds all files (not directories) in the jar with the name specified and in the directory specified.
- fromOptions(Options) - Static method in class com.vaadin.flow.server.frontend.FrontendTools
-
Creates a
FrontendToolsinstance configured from the givenOptions, using the node/pnpm related settings collected there. - FrontendBuildUtils - Class in com.vaadin.flow.server.frontend
-
Utility class for frontend build operations.
- FrontendBuildUtils() - Constructor for class com.vaadin.flow.server.frontend.FrontendBuildUtils
- FrontendDependencies - Class in com.vaadin.flow.server.frontend.scanner
-
Represents the class dependency tree of the application.
- FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) - Constructor for class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- FrontendDependenciesScanner - Interface in com.vaadin.flow.server.frontend.scanner
-
Frontend dependencies scanner.
- FrontendDependenciesScanner.FrontendDependenciesScannerFactory - Class in com.vaadin.flow.server.frontend.scanner
-
Frontend dependencies scanner factory.
- FrontendDependenciesScannerFactory() - Constructor for class com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner.FrontendDependenciesScannerFactory
- frontendImportsFound(JsonNode, Options) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- FrontendTools - Class in com.vaadin.flow.server.frontend
-
Provides access to frontend tools (Node.js and npm, pnpm, bun) and optionally installs the tools if needed.
- FrontendTools(FrontendToolsSettings) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
-
Creates an instance of the class using the
baseDiras a base directory to locate the tools and the directory returned by thealternativeDirGetteras a directory to install tools if they are not found and use it as an alternative tools location. - FrontendTools(ApplicationConfiguration, File) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
-
Creates an instance using the the given project directory and application configuration.
- FrontendTools(String, Supplier<String>, String, URI, boolean, boolean) - Constructor for class com.vaadin.flow.server.frontend.FrontendTools
-
Deprecated.
- FrontendToolsLocator - Class in com.vaadin.flow.server.frontend
-
Helps to locate the tools in the system by their names.
- FrontendToolsLocator() - Constructor for class com.vaadin.flow.server.frontend.FrontendToolsLocator
- FrontendToolsSettings - Class in com.vaadin.flow.server.frontend
-
Configuration object for controlling the
FrontendToolsfeatures. - FrontendToolsSettings(String, SerializableSupplier<String>) - Constructor for class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Create a tools configuration object.
- FrontendWebComponentGenerator - Class in com.vaadin.flow.server.frontend
-
Generates embeddable web component files in npm mode, hiding the complexity caused by using a different class loader.
- FrontendWebComponentGenerator(ClassFinder) - Constructor for class com.vaadin.flow.server.frontend.FrontendWebComponentGenerator
-
Creates a new instances and stores the
finderto be used for locatingWebComponentModulesWriterandWebComponentExporter/WebComponentExporterFactoryclasses.
G
- GeneratedFilesSupport - Class in com.vaadin.flow.server.frontend
-
A helper for tasks to handle generated files.
- GeneratedFilesSupport() - Constructor for class com.vaadin.flow.server.frontend.GeneratedFilesSupport
- GenerateMainImports - Class in com.vaadin.flow.server.frontend
-
Collect generated-flow-imports content for project to use to determine if dev-bundle contains all required imports.
- GenerateMainImports(Options, JsonNode) - Constructor for class com.vaadin.flow.server.frontend.GenerateMainImports
- generateVersionsJson(ObjectNode) - Method in class com.vaadin.flow.server.frontend.NodeUpdater
-
Generate versions json file for version pinning.
- generateWebComponents(File, ThemeDefinition) - Method in class com.vaadin.flow.server.frontend.FrontendWebComponentGenerator
-
Collects
WebComponentModulesWriterclass and classes that extendWebComponentExporter/WebComponentExporterFactoryusingfinder. - getAlternativeDirGetter() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Get the alternative directory getter.
- getAnnotatedClasses(Class<? extends Annotation>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
- getAnnotatedClasses(Class<? extends Annotation>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
- getAnnotatedClasses(Class<? extends Annotation>) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Get annotated classes in the classloader.
- getAnnotatedClasses(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Get annotated classes in the classloader.
- getApplicationBooleanProperty(String, boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Retrieves the value of a boolean application property.
- getApplicationStringProperty(String, String) - Method in class com.vaadin.flow.server.frontend.Options
-
Retrieves the value of a string application property.
- getAssets() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- getAssets() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all npm package assets for the application.
- getBaseDir() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Get the defined base dir.
- getBuildDirectory() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the directory used for the build output.
- getBuildDirectoryName() - Method in class com.vaadin.flow.server.frontend.Options
-
Get the name of the used build directory.
- getBunExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Locate
bunexecutable. - getClasses() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all Java classes considered when looking for used dependencies.
- getClasses() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all Java classes considered when looking for used dependencies.
- getClassFinder() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the used class finder.
- getClassLoader() - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
- getClassLoader() - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
- getClassLoader() - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Get class loader which is used to find classes.
- getCss() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getCss() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all the CSS files used by the application.
- getCss() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all the CSS files used by the application.
- getDefaultPackageJson(Options, FrontendDependenciesScanner, ObjectNode) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- getDependencyTriggers() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- getDependencyTriggers() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getDevAssets() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- getDevAssets() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all npm packages assets needed only for development.
- getDevPackages() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- getDevPackages() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all npm packages needed only for development.
- getDownloadRoot(Platform) - Static method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Get the download root for the given platform.
- getEntryPoints() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all entryPoints in the application.
- getExcludePostinstallPackages() - Method in class com.vaadin.flow.server.frontend.Options
- getExistingNodeExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Returns the path to a Node.js executable that can be used without downloading or installing one, either a Node.js that has already been resolved during this build or a globally available Node.js found on the system
PATH. - getFeatureFlags() - Method in class com.vaadin.flow.server.frontend.Options
-
Get the available feature flags.
- getFileContent() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
-
Get file content for writing to the generated file.
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateBootstrap
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateCommercialBanner
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateFeatureFlags
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexHtml
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateServiceWorker
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTailwindCss
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTailwindJs
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateViteDevMode
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentBootstrap
- getFileContent() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentHtml
- getFileContent(String) - Method in class com.vaadin.flow.server.frontend.TaskGenerateReactFiles
- getFileContents(File, String) - Method in class com.vaadin.flow.server.frontend.JarContentsManager
-
Tries to find a file by its path (case sensitive) in jar file.
- getFiles() - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Gets paths of all generated files, whether they have been written to disk or not.
- getFiles(Path) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Gets paths of files generated under the given
rootfolder. - getFinder() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- getFrontendDependenciesScanner() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the frontend dependencies scanner to use.
- getFrontendDirectory() - Method in class com.vaadin.flow.server.frontend.Options
-
Get the defined frontend directory.
- getFrontendExtraFileExtensions() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the project file extensions.
- getFrontendGeneratedFolder() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the folder where frontend files should be generated.
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
-
Get the generated file where content will be written.
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateBootstrap
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateCommercialBanner
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateFeatureFlags
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexHtml
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateServiceWorker
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTailwindCss
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTailwindJs
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateViteDevMode
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentBootstrap
- getGeneratedFile() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentHtml
- getId() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
-
The id getter.
- getImportsNotFoundMessage() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- getInclude() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
-
The include getter.
- getInsecureProxy() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
-
Get first proxy that is not secure.
- getInstallDirectory() - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- getJarFiles() - Method in class com.vaadin.flow.server.frontend.Options
- getJarFrontendResourcesFolder() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the folder to which frontend resources from add-on jars are copied.
- getJarResource(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Get resource from JAR package.
- getJarResourceString(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Get resource from JAR package.
- getJavaResourceFolder() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the folder containing java resources, typically src/main/resources in a Maven project.
- getLines() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- getLocalResourcesFolder() - Method in class com.vaadin.flow.server.frontend.Options
- getLogger() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- getLookup() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the lookup instance to use for internal lookups.
- getLumoTheme() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- getMetaInfResourcesDirectory() - Method in class com.vaadin.flow.server.frontend.Options
-
Get the resources directory if defined.
- getMinimumFrontendPackageAgeDays() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the minimum age (in days) a frontend package version must have before npm, pnpm or bun is allowed to install it.
- getModules() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getModules() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all JS modules needed for run the application.
- getModules() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all ES6 modules needed for run the application.
- getModulesDevelopment() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all JS modules needed in development mode.
- getModulesDevelopment() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all ES6 modules needed only in development mode.
- getModulesDevelopmentOnly() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getName() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- getNodeBinary() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Gets a path to the used node binary.
- getNodeDownloadRoot() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Get the node download root to be used for downloading node.
- getNodeDownloadRoot() - Method in class com.vaadin.flow.server.frontend.Options
- getNodeExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Locate
nodeexecutable. - getNodeFolder() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Get the configured node folder.
- getNodeFolder() - Method in class com.vaadin.flow.server.frontend.Options
- getNodeModulesFolder() - Method in class com.vaadin.flow.server.frontend.Options
- getNodeVersion() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Gets the version of the node executable.
- getNodeVersion() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Get the defined node version.
- getNodeVersion() - Method in class com.vaadin.flow.server.frontend.Options
- getNpmExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Locate
npmexecutable. - getNpmFolder() - Method in class com.vaadin.flow.server.frontend.Options
-
Get the npm folder used for this build.
- getNpmPackageExecutable(String, String, File) - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Gives a path to the executable (bin) JS file of the given package using the native node resolution mechanism.
- getNpmVersion() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Executes
npm --versionto and parses the result. - getOfflinePath(PwaConfiguration, File) - Static method in class com.vaadin.flow.server.frontend.TaskUpdateSettingsFile
-
Computes the value for the
OFFLINE_PATHconstant that Vite compiles into the service worker. - getPackageJson(Options, FrontendDependenciesScanner) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
-
Get the package.json file from disk if available else generate in memory.
- getPackageJsonFile() - Method in class com.vaadin.flow.server.frontend.NodeUpdater
- getPackageJsonHash(JsonNode) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- getPackageLockFile() - Method in class com.vaadin.flow.server.frontend.NodeUpdater
- getPackages() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all npm packages the application depends on.
- getPackages() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all npm packages the application depends on.
- getPnpmExecutable() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Locate
pnpmexecutable. - getPostinstallPackages() - Method in class com.vaadin.flow.server.frontend.Options
- getProdBundle(File) - Static method in class com.vaadin.flow.server.frontend.ProdBundleUtils
-
Get the application specific production bundle file.
- getProdBundleResource(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- getProductIfCvdl(File, String) - Static method in class com.vaadin.flow.server.frontend.CvdlProducts
-
Returns product information if the given npm module refers to a Vaadin commercial component.
- getProxies() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Read list of configured proxies in order from system properties, .npmrc file in the project root folder, .npmrc file in user root folder and system environment variables.
- getProxies(File) - Static method in class com.vaadin.flow.server.frontend.ProxyFactory
-
Read list of configured proxies in order from system properties, .npmrc file in the project root folder, .npmrc file in user root folder and system environment variables.
- getProxyForUrl(String) - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
-
Get a proxy for url.
- getPwaConfiguration() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get the PWA configuration of the application.
- getPwaConfiguration() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get the
PwaConfigurationof the application. - getResource(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
- getResource(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
- getResource(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Get a resource from the classpath.
- getResourceOutputDirectory() - Method in class com.vaadin.flow.server.frontend.Options
- getResources(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
- getResources(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
- getResources(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Get all resources with the given name from the classpath.
- getScripts() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getScripts() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all the JS files used by the application.
- getScripts() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all the JS files used by the application.
- getScriptsDevelopment() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get all the JS files needed in development mode.
- getScriptsDevelopment() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get all the JS files needed only in development mode.
- getScriptsDevelopmentOnly() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getSecureProxy() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
-
Get a defined secure proxy.
- getStatsHash(JsonNode) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- getSubTypesOf(Class<T>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
- getSubTypesOf(Class<T>) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
- getSubTypesOf(Class<T>) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Gets all subtypes in hierarchy of a given type.
- getSubTypesOf(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Gets all subtypes in hierarchy of a given type, using FQN string.
- getTheme() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get the
AbstractThemeinstance used in the application. - getTheme() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get the
AbstractThemeinstance used in the application. - getThemeDefinition() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
-
Get the
ThemeDefinitionof the application. - getThemeDefinition() - Method in interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner
-
Get the
ThemeDefinitionof the application. - getThemefor() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
-
The themefor getter.
- getThemeIdPrefix() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- getTokenFile() - Method in class com.vaadin.flow.server.frontend.Options
- getTokenFileData() - Method in class com.vaadin.flow.server.frontend.Options
- getType() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- getType() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- getUri() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Get the proxy uri.
- getVaadinVersion(Options) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Gets the current Vaadin version, as declared by the versions files the platform ships.
- getValue() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
-
The value getter.
- getWebappResourcesDirectory() - Method in class com.vaadin.flow.server.frontend.Options
-
Get the output directory for frontend build output.
- getWebpackNodeEnvironment() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Deprecated, for removal: This API element is subject to removal in a future version.Webpack is not used anymore, this method is obsolete and have no replacements.
- GLOBAL - Static variable in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
H
- hasBundleFile(File, ClassFinder, String) - Static method in class com.vaadin.flow.server.frontend.ProdBundleUtils
-
Checks if the given file is part of the production bundle in use, which is the application specific bundle when the application has one and the default bundle from the class path otherwise.
- hashAndBundleModulesEqual(JsonNode, JsonNode, Map<String, String>) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
-
Verify that package hash versions are equal and that all project npmPackages are in bundle.
- hashCode() - Method in record class com.vaadin.flow.server.frontend.NodeTasks.NodeTasksLockInfo
-
Returns a hash code value for this object.
- hashCode() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- hashCode() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
- hasJarBundle(String, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
-
Check if jar bundle exists on given path.
- host - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Proxy host.
- HTTPS_PROTOCOLS - Static variable in class com.vaadin.flow.server.frontend.installer.DefaultFileDownloader
I
- id - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Id of proxy.
- importedFileExists(String) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- inMemoryCollection() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- install() - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Install node and npm.
- INSTALL_PATH_PREFIX - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- InstallationException - Exception Class in com.vaadin.flow.server.frontend.installer
-
Exception indicating a failure during installation of node and npm.
- InstallationException(String) - Constructor for exception class com.vaadin.flow.server.frontend.installer.InstallationException
-
Exception with message.
- InstallationException(String, Throwable) - Constructor for exception class com.vaadin.flow.server.frontend.installer.InstallationException
-
Exceptioon with message and cause.
- INTERNAL - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
- isBundleBuild() - Method in class com.vaadin.flow.server.frontend.Options
-
Check if a bundle build should run.
- isCiBuild() - Method in class com.vaadin.flow.server.frontend.Options
- isCleanNpmFiles() - Method in class com.vaadin.flow.server.frontend.Options
-
Deprecated, for removal: This API element is subject to removal in a future version.used internally only for testing, to be removed without a replacement.
- isCleanOldGeneratedFiles() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets if generated files from a previous execution that are no more created should be removed.
- isCommercialBannerEnabled() - Method in class com.vaadin.flow.server.frontend.Options
-
Checks if the commercial banner is enabled for the build.
- isCompressBundle() - Method in class com.vaadin.flow.server.frontend.Options
-
Get if frontend bundle should be compressed or not.
- isCopyTemplates() - Method in class com.vaadin.flow.server.frontend.Options
- isCreateMissingPackageJson() - Method in class com.vaadin.flow.server.frontend.Options
- isDevBundleBuild() - Method in class com.vaadin.flow.server.frontend.Options
-
Check if a dev mode bundle build should run.
- isDisabledExperimentalClass(String) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- isEager() - Method in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- isEager() - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- isEmpty() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig
-
Check if no proxies have been defined.
- isEnableBun() - Method in class com.vaadin.flow.server.frontend.Options
- isEnableConfigUpdate() - Method in class com.vaadin.flow.server.frontend.Options
- isEnableImportsUpdate() - Method in class com.vaadin.flow.server.frontend.Options
- isEnablePackagesUpdate() - Method in class com.vaadin.flow.server.frontend.Options
- isEnablePnpm() - Method in class com.vaadin.flow.server.frontend.Options
- isForceAlternativeNode() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Check if alternative node usage should be forced.
- isForceProductionBuild() - Method in class com.vaadin.flow.server.frontend.Options
- isFrontendHotdeploy() - Method in class com.vaadin.flow.server.frontend.Options
-
Checks if running with a dev server (when not in production mode).
- isFrontendIgnoreVersionChecks() - Method in class com.vaadin.flow.server.frontend.Options
-
Whether to ignore node/npm tool version checks or not.
- isGenerateEmbeddableWebComponents() - Method in class com.vaadin.flow.server.frontend.Options
- isHillaUsed(File, ClassFinder) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Checks if Hilla is available and Hilla views are used in the project based on what is in routes.ts or routes.tsx file.
- isIgnoreVersionChecks() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Check if version checks should be ignored.
- isNonProxyHost(String) - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Check if given host is excluded for proxy.
- isNpmExcludeWebComponents() - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to exclude web component npm packages in packages.json.
- isPlatformMajorVersionUpdated(Options, File, File, File) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Compares current platform version with the one last recorded as installed in node_modules/.vaadin/vaadin_version.
- isPlatformVersionUpdated(Options, File, File) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Compares current platform version with the one last recorded as installed in node_modules/.vaadin/vaadin_version.
- isProductionMode() - Method in class com.vaadin.flow.server.frontend.Options
-
Gets the production mode.
- isReactEnabled() - Method in class com.vaadin.flow.server.frontend.Options
- isReactModuleAvailable(Options) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Is the React module available in the classpath.
- isRequireHomeNodeExec() - Method in class com.vaadin.flow.server.frontend.Options
- isRunNpmInstall() - Method in class com.vaadin.flow.server.frontend.Options
- isSecure() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Check if the proxy is secure.
- isSkipDevBundle() - Method in class com.vaadin.flow.server.frontend.Options
-
Is dev bundle build skipped or not.
- isTailwindCssEnabled(Options) - Static method in class com.vaadin.flow.server.frontend.FrontendBuildUtils
-
Checks if integration with Tailwind CSS framework is enabled.
- isUseByteCodeScanner() - Method in class com.vaadin.flow.server.frontend.Options
- isUseGlobalPnpm() - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Check if global pnpm should be used.
- isUseGlobalPnpm() - Method in class com.vaadin.flow.server.frontend.Options
J
- JarContentsManager - Class in com.vaadin.flow.server.frontend
-
Shared code for managing contents of jar files.
- JarContentsManager() - Constructor for class com.vaadin.flow.server.frontend.JarContentsManager
L
- loadClass(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.CachedClassFinder
- loadClass(String) - Method in class com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder
- loadClass(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Load a class in the classloader.
- logChangedFiles(List<String>, String) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
- LUMO - Static variable in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
M
- MAX_SUPPORTED_NODE_MAJOR_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
-
Maximum supported Node.js major version.
- merge(Map<T, List<String>>) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- MINIMUM_AUTO_INSTALLED_NODE - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
-
Minimum Node.js version for auto-installed versions in ~/.vaadin.
- MISSING_ROUTES_EXPORT - Static variable in class com.vaadin.flow.server.frontend.TaskGenerateReactFiles
- modify(List<String>, Options) - Method in interface com.vaadin.flow.server.frontend.TypeScriptBootstrapModifier
-
Modifies the bootstrap typescript by mutating the parameter.
- modify(List<String>, Options, FrontendDependenciesScanner) - Method in interface com.vaadin.flow.server.frontend.TypeScriptBootstrapModifier
-
Deprecated, for removal: This API element is subject to removal in a future version.
frontendDependenciesScannercan be obtained callingOptions.getFrontendDependenciesScanner(). UseTypeScriptBootstrapModifier.modify(List, Options)instead
N
- needsBuild(Options, FrontendDependenciesScanner, Mode) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
-
Checks if an application needs a new frontend bundle.
- needsBundleBuild(File) - Static method in class com.vaadin.flow.server.frontend.BundleValidationUtil
-
Checks if a new production bundle is needed by restoring re-bundle checker result flag from a temporal file.
- NO_IMPORT - Static variable in class com.vaadin.flow.server.frontend.TaskGenerateReactFiles
- NODE_MODULES - Static variable in class com.vaadin.flow.server.frontend.TaskCleanFrontendFiles
- NodeInstaller - Class in com.vaadin.flow.server.frontend.installer
-
Node installation class.
- NodeInstaller(File, Platform, ArchiveExtractor, FileDownloader) - Constructor for class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Initialize a new NodeInstaller.
- NodeInstaller(File, Platform, List<ProxyConfig.Proxy>) - Constructor for class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Create NoodeInstaller with default extractor and downloader.
- NodeInstaller(File, List<ProxyConfig.Proxy>) - Constructor for class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Create NodeInstaller with default extractor and downloader and guess platform.
- NodeTasks - Class in com.vaadin.flow.server.frontend
-
An executor that it's run when the servlet context is initialised in dev-mode or when flow-maven-plugin goals are run.
- NodeTasks(Options) - Constructor for class com.vaadin.flow.server.frontend.NodeTasks
-
Initialize tasks with the given options.
- NodeTasks.NodeTasksLockInfo - Record Class in com.vaadin.flow.server.frontend
- NodeTasksLockInfo(long, String) - Constructor for record class com.vaadin.flow.server.frontend.NodeTasks.NodeTasksLockInfo
-
Creates an instance of a
NodeTasksLockInforecord class. - NodeUpdater - Class in com.vaadin.flow.server.frontend
-
Base abstract class for frontend updaters that needs to be run when in dev-mode or from the flow maven plugin.
- NodeUpdater(Options) - Constructor for class com.vaadin.flow.server.frontend.NodeUpdater
-
Constructor.
- nonProxyHosts - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Excluded hosts string delimited by '|'.
- npmSupportsMinReleaseAge(List<String>) - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Returns whether the given npm command resolves to a version that supports the
--min-release-ageinstall flag (seeFrontendTools.MIN_NPM_VERSION_FOR_RELEASE_AGE).
O
- onProgress(long, long, double) - Method in interface com.vaadin.flow.server.frontend.installer.FileDownloader.ProgressListener
-
Called periodically during a download.
- options - Variable in class com.vaadin.flow.server.frontend.NodeUpdater
- Options - Class in com.vaadin.flow.server.frontend
-
Build a
NodeExecutorinstance. - Options(Lookup, ClassFinder, File) - Constructor for class com.vaadin.flow.server.frontend.Options
-
Creates a new instance.
- Options(Lookup, File) - Constructor for class com.vaadin.flow.server.frontend.Options
-
Creates a new instance.
P
- password - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Password for proxy.
- pid() - Method in record class com.vaadin.flow.server.frontend.NodeTasks.NodeTasksLockInfo
-
Returns the value of the
pidrecord component. - pinNpmDependency(JsonNode, JsonNode, String) - Static method in class com.vaadin.flow.server.frontend.TaskUpdatePackages
- populateTokenFileData(JsonNode) - Method in class com.vaadin.flow.server.frontend.Options
-
Fill token file data into the provided
object. - port - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Proxy port.
- ProdBundleUtils - Class in com.vaadin.flow.server.frontend
-
Helpers related to the production bundle.
- protocol - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Protocol used for proxy.
- PROVIDED_VERSION - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- Proxy(String, String, String) - Constructor for class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Construct a Proxy object out of a proxy url.
- Proxy(String, String, String, int, String, String, String) - Constructor for class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Construct a Proxy object.
- ProxyConfig - Class in com.vaadin.flow.server.frontend.installer
-
Proxy configuration used for downloads and executions.
- ProxyConfig(List<ProxyConfig.Proxy>) - Constructor for class com.vaadin.flow.server.frontend.installer.ProxyConfig
-
Create a new proxy configuration with given proxies.
- ProxyConfig.Proxy - Class in com.vaadin.flow.server.frontend.installer
-
Class for holding proxy information.
- ProxyFactory - Class in com.vaadin.flow.server.frontend
-
Factory for reading proxy configurations from various sources including system properties, .npmrc files, and environment variables.
- ProxyFactory() - Constructor for class com.vaadin.flow.server.frontend.ProxyFactory
R
- README - Static variable in class com.vaadin.flow.server.frontend.TaskRunDevBundleBuild
- resolveResource(String) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
- ROUTE - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
- run() - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
S
- setAlternativeDirGetter(SerializableSupplier<String>) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set the installation directory if no tools are found.
- setBaseDir(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set the base directory for locating tools.
- setCopyAssets(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to copy npm assets or not.
- setDependencyTriggers(List<String>) - Method in class com.vaadin.flow.server.frontend.scanner.EntryPointData
- setForceAlternativeNode(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set if the alternative folder should always be used even if a global installation exists.
- setGeneratedFileSupport(GeneratedFilesSupport) - Method in class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
- setGeneratedFileSupport(GeneratedFilesSupport) - Method in interface com.vaadin.flow.server.frontend.FallibleCommand
-
Accepts
GeneratedFilesSupportutility allows to track generated files but write them only when the content is changed, preventing filesystem watchers to be triggered when not required. - setGeneratedFileSupport(GeneratedFilesSupport) - Method in class com.vaadin.flow.server.frontend.TaskRemoveOldFrontendGeneratedFiles
- setGeneratedFileSupport(GeneratedFilesSupport) - Method in class com.vaadin.flow.server.frontend.TaskUpdateImports
- setGeneratedFileSupport(GeneratedFilesSupport) - Method in class com.vaadin.flow.server.frontend.TaskWriteGeneratedFilesList
- setIgnoreVersionChecks(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set if node and npm versions should be checked or not.
- setJavaResourceFolder(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Set the java resources folder to be checked for feature file.
- setNodeDownloadRoot(URI) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set the root URI for downloading node.
- setNodeDownloadRoot(URI) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Set a custom download root.
- setNodeFolder(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set the folder containing the Node.js executable.
- setNodeVersion(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Set the node version to install when installation is required.
- setNodeVersion(String) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Set the node version to install.
- setPassword(String) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Set password to use.
- setUseGlobalPnpm(boolean) - Method in class com.vaadin.flow.server.frontend.FrontendToolsSettings
-
Force usage of global pnpm.
- setUserName(String) - Method in class com.vaadin.flow.server.frontend.installer.NodeInstaller
-
Set user name to use.
- SHA_SUMS_FILE - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator
-
Check if it should generate the file or not.
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateBootstrap
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateCommercialBanner
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateFeatureFlags
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexHtml
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateIndexTs
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateServiceWorker
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTailwindCss
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTailwindJs
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateViteDevMode
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentBootstrap
- shouldGenerate() - Method in class com.vaadin.flow.server.frontend.TaskGenerateWebComponentHtml
- shouldInspectClass(String) - Method in interface com.vaadin.flow.server.frontend.scanner.ClassFinder
-
Determines whether the specified class should be inspected for Vaadin-related resources.
- shouldVisit(String) - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- skipDevBundleBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Set to true to skip dev bundle build in case a dev bundle exists.
- SUPPORTED_NODE_VERSION - Static variable in class com.vaadin.flow.server.frontend.FrontendTools
T
- TaskCleanFrontendFiles - Class in com.vaadin.flow.server.frontend
-
Clean any frontend files generated for creation on a new development or production bundle.
- TaskCleanFrontendFiles(Options) - Constructor for class com.vaadin.flow.server.frontend.TaskCleanFrontendFiles
-
Scans the jar files given defined by
resourcesToScan. - TaskCompressStaticResources - Class in com.vaadin.flow.server.frontend
-
Pre-compresses static resources served straight from META-INF/resources (e.g.
- TaskCopyFrontendFiles - Class in com.vaadin.flow.server.frontend
-
Copies all frontend resources from JAR files into a given folder.
- TaskCopyLocalFrontendFiles - Class in com.vaadin.flow.server.frontend
-
Copies JavaScript files from the given local frontend folder.
- TaskCopyNpmAssetsFiles - Class in com.vaadin.flow.server.frontend
-
Copies JavaScript and CSS files from JAR files into a given folder.
- TaskCopyTemplateFiles - Class in com.vaadin.flow.server.frontend
-
Copies template files to the target folder so as to be available for parsing at runtime in production mode.
- TaskGenerateBootstrap - Class in com.vaadin.flow.server.frontend
-
A task for generating the bootstrap file
FrontendUtils.BOOTSTRAP_FILE_NAMEduring `package` Maven goal. - TaskGenerateCommercialBanner - Class in com.vaadin.flow.server.frontend
-
Generate
commercial-banner.jsif it is missing in frontend/generated folder. - TaskGenerateEndpoint - Interface in com.vaadin.flow.server.frontend
-
Generate the TS files for endpoints, and the Client API file.
- TaskGenerateFeatureFlags - Class in com.vaadin.flow.server.frontend
-
A task for generating the feature flags file
FrontendUtils.FEATURE_FLAGS_FILE_NAMEduring `package` Maven goal. - TaskGenerateIndexHtml - Class in com.vaadin.flow.server.frontend
-
Generate the default
index.htmlinto the frontendgenerated/folder so the file is not committed to source control. - TaskGenerateIndexTs - Class in com.vaadin.flow.server.frontend
-
Generate
index.tsif it is missing in frontend folder. - TaskGenerateOpenAPI - Interface in com.vaadin.flow.server.frontend
-
Generate OpenAPI json file for Vaadin Endpoints.
- TaskGeneratePackageJson - Class in com.vaadin.flow.server.frontend
-
Creates the
package.jsonif missing. - TaskGeneratePWAIcons - Class in com.vaadin.flow.server.frontend
-
Generates necessary PWA icons.
- TaskGeneratePWAIcons(Options, PwaConfiguration) - Constructor for class com.vaadin.flow.server.frontend.TaskGeneratePWAIcons
- TaskGenerateReactFiles - Class in com.vaadin.flow.server.frontend
-
Generate default files for react-router if missing from the frontend folder.
- TaskGenerateServiceWorker - Class in com.vaadin.flow.server.frontend
-
Generate
index.htmlif it is missing in frontend folder. - TaskGenerateTailwindCss - Class in com.vaadin.flow.server.frontend
-
Generate
tailwind.cssif it is missing in the generated frontend folder. - TaskGenerateTailwindJs - Class in com.vaadin.flow.server.frontend
-
Generate
tailwind.jswrapper if it is missing in the generated frontend folder. - TaskGenerateTsConfig - Class in com.vaadin.flow.server.frontend
-
Generate
tsconfig.jsonif it is missing in project folder. - TaskGenerateTsDefinitions - Class in com.vaadin.flow.server.frontend
-
Generate
types.d.tsif it is missing in project folder andtsconfig.jsonexists in project folder. - TaskGenerateViteDevMode - Class in com.vaadin.flow.server.frontend
-
Generate
vite-devmode.tsif it is missing in frontend/generated folder. - TaskGenerateWebComponentBootstrap - Class in com.vaadin.flow.server.frontend
-
A task for generating the bootstrap file for exported web components
FrontendUtils.WEB_COMPONENT_BOOTSTRAP_FILE_NAMEduring `package` Maven goal. - TaskGenerateWebComponentHtml - Class in com.vaadin.flow.server.frontend
-
Generate
web-component.htmlif it is missing in frontend folder. - TaskInstallFrontendBuildPlugins - Class in com.vaadin.flow.server.frontend
-
Task that installs any Flow frontend plugins into node_modules/@vaadin for use with frontend compilation.
- TaskInstallFrontendBuildPlugins(Options) - Constructor for class com.vaadin.flow.server.frontend.TaskInstallFrontendBuildPlugins
-
Copy Flow frontend plugins into
PLUGIN_TARGETunder the build directory. - TaskPrepareProdBundle - Class in com.vaadin.flow.server.frontend
-
Copies production bundle files from pre-compiled bundle JAR into a folder where production bundle is normally located.
- TaskPrepareProdBundle(Options, PwaConfiguration) - Constructor for class com.vaadin.flow.server.frontend.TaskPrepareProdBundle
- TaskProcessStylesheetCss - Class in com.vaadin.flow.server.frontend
-
Process CSS files in META-INF/resources for production build.
- TaskProcessStylesheetCss(Options) - Constructor for class com.vaadin.flow.server.frontend.TaskProcessStylesheetCss
-
Creates a new task for processing stylesheet CSS files.
- TaskRemoveOldFrontendGeneratedFiles - Class in com.vaadin.flow.server.frontend
-
Deletes old files from frontend generated folder.
- TaskRemoveOldFrontendGeneratedFiles(Options) - Constructor for class com.vaadin.flow.server.frontend.TaskRemoveOldFrontendGeneratedFiles
- TaskRunDevBundleBuild - Class in com.vaadin.flow.server.frontend
-
Compiles the dev mode bundle if it is out of date.
- TaskRunNpmInstall - Class in com.vaadin.flow.server.frontend
-
Run
npm installafter dependencies have been updated. - TaskUpdateImports - Class in com.vaadin.flow.server.frontend
-
An updater that it's run when the servlet context is initialised in dev-mode or when flow-maven-plugin goals are run in order to update Flow imports file and "jar-resources" contents by visiting all classes with
JsModuleandThemeannotations. - TaskUpdateOldIndexTs - Class in com.vaadin.flow.server.frontend
-
Updated
index.tsif it imports Flow from an old location. - TaskUpdatePackages - Class in com.vaadin.flow.server.frontend
-
Updates
package.jsonby visitingNpmPackageannotations found in the classpath. - TaskUpdateSettingsFile - Class in com.vaadin.flow.server.frontend
-
Creates a vaadin-dev-server-settings.json file for use with dev server configuration.
- TaskUpdateThemeImport - Class in com.vaadin.flow.server.frontend
-
Task generating the theme definition file 'theme.js' for importing application theme into the generated frontend directory.
- TaskUpdateVite - Class in com.vaadin.flow.server.frontend
-
Updates the Vite configuration files according with current project settings.
- TaskWriteGeneratedFilesList - Class in com.vaadin.flow.server.frontend
-
Writes a manifest listing the frontend files generated by Flow under the frontend generated folder during the current run.
- themeConfigurationChanged(Options, JsonNode, FrontendDependenciesScanner) - Static method in class com.vaadin.flow.server.frontend.ThemeValidationUtil
- themeShadowDOMStylesheetsChanged(Options, JsonNode, FrontendDependenciesScanner) - Static method in class com.vaadin.flow.server.frontend.ThemeValidationUtil
-
Checks if theme has legacy Shadow DOM stylesheets in <theme>/components folder and if their content has changed.
- ThemeValidationUtil - Class in com.vaadin.flow.server.frontend
-
Theme handling methods.
- ThemeValidationUtil() - Constructor for class com.vaadin.flow.server.frontend.ThemeValidationUtil
- toString() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
- toString() - Method in record class com.vaadin.flow.server.frontend.NodeTasks.NodeTasksLockInfo
-
Returns a string representation of this record class.
- toString() - Method in class com.vaadin.flow.server.frontend.scanner.CssData
- toString() - Method in class com.vaadin.flow.server.frontend.scanner.FrontendDependencies
- track(File) - Method in class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
-
Marks the give file as generated by the task.
- track(File) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Marks the give file as generated by the task.
- track(Path) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Marks the give file as generated by the task.
- track(Collection<File>) - Method in class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
-
Marks the give files as generated by the task.
- tryLocateTool(String) - Method in class com.vaadin.flow.server.frontend.FrontendToolsLocator
-
Makes an attempt to locate the tool by its name.
- TypeScriptBootstrapModifier - Interface in com.vaadin.flow.server.frontend
-
Implemented by classes that want to modify the bootstrap typescript.
U
- UnknownTaskException - Exception Class in com.vaadin.flow.server.frontend
-
Exception thrown for when a node task that is not in the task list is encountered.
- UnknownTaskException(FallibleCommand) - Constructor for exception class com.vaadin.flow.server.frontend.UnknownTaskException
-
Exception constructor.
- UNOFFICIAL_NODEJS_DOWNLOAD_ROOT - Static variable in class com.vaadin.flow.server.frontend.installer.NodeInstaller
- unpackBundle(File, File) - Static method in class com.vaadin.flow.server.frontend.ProdBundleUtils
-
Unpack the compressed prod bundle from src/main/bundles if it exists into the given location.
- useAuthentication() - Method in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
Check if proxy uses authentication.
- useByteCodeScanner(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets frontend scanner strategy: byte code scanning strategy is used if
byteCodeScanneristrue, full classpath scanner strategy is used otherwise (by default). - useGlobalPnpm(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Uses globally installed pnpm tool for frontend packages installation.
- username - Variable in class com.vaadin.flow.server.frontend.installer.ProxyConfig.Proxy
-
User name for proxy.
V
- VAADIN_APP_PACKAGE_HASH - Static variable in class com.vaadin.flow.server.frontend.TaskUpdatePackages
- VAADIN_JSON - Static variable in class com.vaadin.flow.server.frontend.NodeUpdater
- VAADIN_JSON - Static variable in class com.vaadin.flow.server.frontend.TaskRunDevBundleBuild
- validateNodeAndNpmVersion() - Method in class com.vaadin.flow.server.frontend.FrontendTools
-
Validate that the found node and npm versions are new enough.
- valueOf(String) - Static method in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VerificationException - Exception Class in com.vaadin.frontendtools.installer
-
Exception indicating a failure during downloaded archive verification.
- VerificationException(String) - Constructor for exception class com.vaadin.frontendtools.installer.VerificationException
-
Exceptioon with message.
- VerificationException(String, Throwable) - Constructor for exception class com.vaadin.frontendtools.installer.VerificationException
-
Exceptioon with message and cause.
- verifyPackageLockAndClean() - Method in class com.vaadin.flow.server.frontend.TaskRunNpmInstall
-
Check the lockfile lockversion to see if it is compatible with the used npm version.
- verifyTool(File) - Method in class com.vaadin.flow.server.frontend.FrontendToolsLocator
-
Verifies that the tool specified works by performing its test launch.
W
- warningEmitted - Static variable in class com.vaadin.flow.server.frontend.TaskGenerateTsConfig
-
Keeps track of whether a warning update has already been logged.
- warningEmitted - Static variable in class com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions
-
Keeps track of whether a warning update has already been logged.
- WEB_COMPONENT - Enum constant in enum class com.vaadin.flow.server.frontend.scanner.EntryPointType
- WEB_COMPONENT - Static variable in class com.vaadin.flow.server.frontend.scanner.ChunkInfo
- withApplicationConfiguration(ApplicationConfiguration) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the application configuration for the current options and returns the updated options instance.
- withBuildDirectory(String) - Method in class com.vaadin.flow.server.frontend.Options
-
Use the specified directory name (inside the project folder) for the build output.
- withBuildResultFolders(File, File) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the folders where frontend build results should be stored.
- withBundleBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Whether to run bundle build.
- withCiBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Enables ci build.
- withCleanOldGeneratedFiles(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether generated files from a previous execution that are no more created should be removed.
- withCommercialBanner(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether the build could generate an application with a commercial banner.
- withCompressBundle(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Set to
falseto skip frontend bundle compression. - withCopyTemplates(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether copy templates to
META-INF/VAADIN/config/templates. - withEmbeddableWebComponents(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to collect and package
WebComponentExporterdependencies. - withEnableBun(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Enables bun tool.
- withEnablePnpm(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Enables pnpm tool.
- withExcludePostinstallPackages(List<String>) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the npm packages to exclude from running
postinstallfor. - withFeatureFlags(FeatureFlags) - Method in class com.vaadin.flow.server.frontend.Options
- withForceProductionBuild(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Setting this to
truewill force a build of the production build even if there is a default production bundle that could be used. - withFrontendDependenciesScanner(FrontendDependenciesScanner) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the frontend dependencies scanner to use.
- withFrontendDirectory(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the directory containing the project's frontend files
- withFrontendExtraFileExtensions(List<String>) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the extra file extensions used in the project.
- withFrontendGeneratedFolder(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Set the folder where frontend files should be generated.
- withFrontendHotdeploy(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Whether to run with a dev server (when not in production mode).
- withFrontendIgnoreVersionChecks(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Whether to ignore node/npm tool version checks or not.
- withHomeNodeExecRequired(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Requires node executable to be installed in vaadin home folder.
- withJarFrontendResourcesFolder(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the appropriate npm package folder for copying flow resources in jars.
- withMetaInfResourcesDirectory(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Set where the META-INF/resources files are copied by the build.
- withMinimumFrontendPackageAgeDays(Integer) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the minimum age (in days) a frontend package version must have before it is allowed to be installed by npm, pnpm or bun.
- withNodeDownloadRoot(URI) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the download node.js URL.
- withNodeFolder(String) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the folder containing the Node.js executable.
- withNodeVersion(String) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the node.js version to be used when node.js is installed automatically by Vaadin, for example
"v16.0.0". - withNpmExcludeWebComponents(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether to exclude web component npm packages in packages.json.
- withPostinstallPackages(List<String>) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the additional npm packages to run
postinstallfor. - withProductionMode(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the production mode.
- withReact(boolean) - Method in class com.vaadin.flow.server.frontend.Options
- withRunNpmInstall(boolean) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets whether run
npm installafter updating dependencies. - withTokenFile(File) - Method in class com.vaadin.flow.server.frontend.Options
-
Sets the token file (flow-build-info.json) path.
- writeIfChanged(File, String) - Method in class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
-
Writes the given content into the given file unless the file already contains that content.
- writeIfChanged(File, String) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Writes the given content into the given file unless the file already contains that content.
- writeIfChanged(File, List<String>) - Method in class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
-
Writes the given content into the given file unless the file already contains that content.
- writeIfChanged(File, List<String>) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Writes the given content into the given file unless the file already contains that content.
- writeIfChanged(Path, String) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Writes the given content into the given file unless the file already contains that content.
- writeIfChanged(Path, List<String>) - Method in class com.vaadin.flow.server.frontend.GeneratedFilesSupport
-
Writes the given content into the given file unless the file already contains that content.
- writeLayouts(Options, Collection<Class<?>>) - Static method in class com.vaadin.flow.server.frontend.TaskGenerateReactFiles
-
Writes the `layout.json` file in the frontend generated folder.
- writeOutput(Map<File, List<String>>) - Method in class com.vaadin.flow.server.frontend.GenerateMainImports
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
FrontendTools(FrontendToolsSettings)instead, as it simplifies configuring the frontend tools and gives the default values to configuration parameters.