Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- applicationIdentifier() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Gets the application identifier.
- applicationProperties() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Application properties file in Spring project.
B
- buildFolder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The folder where everything is built into.
- BuildFrontendUtil - Class in com.vaadin.flow.plugin.base
-
Util class provides all methods a Plugin will need.
- bunEnable() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Instructs to use bun for installing npm frontend resources.
C
- checkRuntimeDependency(String, String, Consumer<String>) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Checks if the artifact defined by given coordinates is a dependency of the project, present at runtime.
- ciBuild() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Setting this to true will run
npm ciinstead ofnpm installwhen using npm. - CleanFrontendException(String, Throwable) - Constructor for exception class com.vaadin.flow.plugin.base.CleanFrontendUtil.CleanFrontendException
- CleanFrontendUtil - Class in com.vaadin.flow.plugin.base
-
Utility class for cleaning the frontend files to a clean state.
- CleanFrontendUtil() - Constructor for class com.vaadin.flow.plugin.base.CleanFrontendUtil
- CleanFrontendUtil.CleanFrontendException - Exception Class in com.vaadin.flow.plugin.base
-
Exception thrown when cleaning the frontend fails.
- CleanOptions - Class in com.vaadin.flow.plugin.base
-
Options for cleaning the frontend files to a clean state.
- CleanOptions() - Constructor for class com.vaadin.flow.plugin.base.CleanOptions
- close() - Method in class com.vaadin.flow.plugin.base.ConvertPolymerCommand
- com.vaadin.flow.plugin.base - package com.vaadin.flow.plugin.base
- com.vaadin.flow.server.scanner - package com.vaadin.flow.server.scanner
- com.vaadin.flow.utils - package com.vaadin.flow.utils
- compressBundle() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Setting this to
falsewill skip compression of the bundle. - ConvertPolymerCommand - Class in com.vaadin.flow.plugin.base
-
A tool-independent implementation of a
convert-polymercommand that converts Polymer-based source files to Lit. - ConvertPolymerCommand(PluginAdapterBase, String, boolean, boolean) - Constructor for class com.vaadin.flow.plugin.base.ConvertPolymerCommand
- convertToUrl(File) - Static method in class com.vaadin.flow.utils.FlowFileUtils
- createLookup(ClassFinder) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Creates a
Lookupfor theClassFinder.
D
- DEPENDENCIES - Static variable in class com.vaadin.flow.plugin.base.CleanFrontendUtil
- DEV_DEPENDENCIES - Static variable in class com.vaadin.flow.plugin.base.CleanFrontendUtil
E
- eagerServerLoad() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Whether to insert the initial Uidl object in the bootstrap index.html.
- execute() - Method in class com.vaadin.flow.plugin.base.ConvertPolymerCommand
F
- FlowFileUtils - Class in com.vaadin.flow.utils
-
Util methods for files manipulation.
- forceMkdir(File) - Static method in class com.vaadin.flow.utils.FlowFileUtils
-
A
FileUtils.forceMkdir(File)wrapper that handlesIOException. - forceProductionBuild() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Setting this to
truewill force a build of the production build even if there is a default production bundle that could be used. - frontendDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
A directory with project's frontend source files.
- frontendExtraFileExtensions() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Get the list of project file extensions.
- frontendOutputDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The folder where the frontend build tool should output index.js and other generated files.
- frontendResourcesDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Defines the project frontend directory from where resources should be copied from for use with webpack.
G
- generateBundle() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Whether to generate a bundle from the project frontend sources or not.
- generatedTsFolder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The folder where flow will put TS API files for client projects.
- generateEmbeddableWebComponents() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Whether to generate embeddable web components from WebComponentExporter inheritors.
- getAnnotatedClasses(Class<? extends Annotation>) - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- getClassFinder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The
ClassFinderthat should be used. - getClassFinder(List<String>) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
creates a
ClassFinderfrom a List of classpathElements. - getClassLoader() - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- getFrontendDirectory(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Get the legacy frontend folder if available and new folder doesn't exist.
- getGeneratedFrontendDirectory(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
The generated folder should be under frontend folder and will be moved to the legacy package if not changed by the user.
- getJarFiles() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The Jar Files that would be searched.
- getResource(String) - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- getSubTypesOf(Class<T>) - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- getTokenFile(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Location of the Token File.
I
- isCleanPackageJson() - Method in class com.vaadin.flow.plugin.base.CleanOptions
- isCommercialBannerEnabled() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Specifies whether to allow building a version of the application with a commercial banner when commercial components are used without a license key.
- isDebugEnabled() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Checks the debug Mode.
- isFrontendHotdeploy() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
- isFrontendIgnoreVersionChecks() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Whether to ignore node/npm tool version checks or not.
- isJarProject() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Indicates that it is a Jar Project.
- isNpmExcludeWebComponents() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Whether to exclude Vaadin web component npm packages in packages.json.
- isPrepareFrontendCacheDisabled() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Prevents tracking state of the `vaadinPrepareFrontend` task in Gradle builds, so that it will re-run every time it is called.
- isReactEnabled() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Set React enabled or disabled.
- isRemoveDevBundle() - Method in class com.vaadin.flow.plugin.base.CleanOptions
- isRemoveFrontendGeneratedFolder() - Method in class com.vaadin.flow.plugin.base.CleanOptions
- isRemoveGeneratedTSFolder() - Method in class com.vaadin.flow.plugin.base.CleanOptions
- isRemoveNodeModules() - Method in class com.vaadin.flow.plugin.base.CleanOptions
- isRemovePackageLock() - Method in class com.vaadin.flow.plugin.base.CleanOptions
- isRemovePnpmFile() - Method in class com.vaadin.flow.plugin.base.CleanOptions
J
- javaResourceFolder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Java resource folder.
- javaSourceFolder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Java source folders for scanning.
L
- loadClass(String) - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- logDebug(CharSequence) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Delegates a debug-Message to a logger.
- logDebug(CharSequence, Throwable) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Delegates a debug-Message to a logger.
- logError(CharSequence) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
delegates a error-Message to a logger.
- logError(CharSequence, Throwable) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Delegates a error-Message to a logger.
- logInfo(CharSequence) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Delegates a info-Message to a logger.
- logWarn(CharSequence) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
delegates a warning-Message to a logger.
- logWarn(CharSequence, Throwable) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Delegates a warning-Message to a logger.
- lookup(Class<T>) - Method in class com.vaadin.flow.utils.LookupImpl
- lookupAll(Class<T>) - Method in class com.vaadin.flow.utils.LookupImpl
- LookupImpl - Class in com.vaadin.flow.utils
-
An implementation of Lookup, which could be used to find service(s) of a given type.
- LookupImpl(ClassFinder) - Constructor for class com.vaadin.flow.utils.LookupImpl
-
Creates an implementation of Lookup.
N
- nodeAutoUpdate() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Whether the alternative node may be auto-updated or not.
- nodeDownloadRoot() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Download node.js from this URL.
- nodeVersion() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The node.js version to be used when node.js is installed automatically by Vaadin, for example `"v12.18.3"`.
- npmFolder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The folder where `package.json` file is located.
O
- openApiJsonFile() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Default generated path of the OpenAPI json.
- optimizeBundle() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Whether to use byte code scanner strategy to discover frontend components.
- OVERRIDES - Static variable in class com.vaadin.flow.plugin.base.CleanFrontendUtil
P
- PluginAdapterBase - Interface in com.vaadin.flow.plugin.base
-
Gives access to plugin-specific implementations and configurations.
- PluginAdapterBuild - Interface in com.vaadin.flow.plugin.base
-
Gives access to plugin-specific implementations and configurations.
- PNPM - Static variable in class com.vaadin.flow.plugin.base.CleanFrontendUtil
- pnpmEnable() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Instructs to use pnpm for installing npm frontend resources.
- postinstallPackages() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Additional npm packages to run postinstall for.
- prepareFrontend(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Prepares the Frontend
- projectBaseDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
The projects root Directory.
- propagateBuildInfo(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Propagates the BuildInfo.
R
- ReflectionsClassFinder - Class in com.vaadin.flow.server.scanner
-
A class finder using org.reflections.
- ReflectionsClassFinder(ClassLoader, URL...) - Constructor for class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- ReflectionsClassFinder(URL...) - Constructor for class com.vaadin.flow.server.scanner.ReflectionsClassFinder
-
Constructor.
- removeBuildFile(PluginAdapterBuild) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Delete the build token file.
- requireHomeNodeExec() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Whether vaadin home node executable usage is forced.
- runCleaning(PluginAdapterBase, CleanOptions) - Static method in class com.vaadin.flow.plugin.base.CleanFrontendUtil
-
Cleans the frontend files to a clean state.
- runDevBuildNodeUpdater(PluginAdapterBuild) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Run a dev-bundle build.
- runFrontendBuild(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Execute the frontend build with the wanted build system.
- runNodeUpdater(PluginAdapterBuild, FrontendDependenciesScanner) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
runs the node-Updater.
- runNpmInstall() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild
-
Whether to run
npm installafter updating dependencies. - runVite(PluginAdapterBase, FrontendTools) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Runs the Vite build
S
- servletResourceOutputDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Defines the output directory for generated non-served resources, such as the token file.
- shouldInspectClass(String) - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
- skipDevBundleBuild() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Enable skip of dev bundle rebuild if a dev bundle exists.
U
- updateBuildFile(PluginAdapterBuild, boolean) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Deprecated, for removal: This API element is subject to removal in a future version.
- updateBuildFile(PluginAdapterBuild, boolean, boolean) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Updates the build info after the bundle has been built by build-frontend.
- useGlobalPnpm() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Instructs to use globally installed pnpm tool or the default supported pnpm version.
V
- VAADIN - Static variable in class com.vaadin.flow.plugin.base.CleanFrontendUtil
- validateLicenses(PluginAdapterBase, FrontendDependenciesScanner) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil
-
Validate pro component licenses.
W
- webpackOutputDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase
-
Deprecated, for removal: This API element is subject to removal in a future version.since 24.8, use
PluginAdapterBase.frontendOutputDirectory()instead. - withCleanPackageJson(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep the package.json file as is.
- withRemoveDevBundle(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep the dev bundle as is.
- withRemoveFrontendGeneratedFolder(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep the frontend generated folder as is.
- withRemoveGeneratedTSFolder(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep the generated ts folder as is.
- withRemoveNodeModules(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep the node_modules folder as is.
- withRemovePackageLock(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep package lock file (pnpm-lock.yaml or bun.lockb or package-lock.json).
- withRemovePnpmFile(boolean) - Method in class com.vaadin.flow.plugin.base.CleanOptions
-
Set to false to keep the .pnpmfile.cjs file as is.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
BuildFrontendUtil.updateBuildFile(PluginAdapterBuild, boolean, boolean)instead