Index (flow-plugin-base 9.1.3 API)

A B C E F G I J L N O P R S U W

A

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.

C

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
convertToUrl(File) - Static method in class com.vaadin.flow.utils.FlowFileUtils: Converts File to URL wrapping checked exception.
createLookup(ClassFinder) - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Creates a Lookup for the ClassFinder.

E

eagerServerLoad() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Whether or not insert the initial Uidl object in the bootstrap index.html.

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 handles IOException.
frontendDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: A directory with project's frontend source 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.
generatedFolder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: The folder where flow will put generated files that will be used by webpack.
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(List<String>) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil: creates a ClassFinder from a List of classpathElements.
getClassFinder() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: The ClassFinder that should be used.
getClassLoader() - Method in class com.vaadin.flow.server.scanner.ReflectionsClassFinder
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.
getUseDeprecatedV14Bootstrapping() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Whether or not we are running in legacy V14 bootstrap mode.

I

isDebugEnabled() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Checks the debug Mode.
isJarProject() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Indicates that it is a Jar Project.
isUseDeprecatedV14Bootstrapping() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Check if the plugin is running in legacy V14 bootstrap mode or not.

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.
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 autoupdated 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.

P

PluginAdapterBase - Interface in com.vaadin.flow.plugin.base: Gives access to access to plugin-spectific implementations and configurations.
PluginAdapterBuild - Interface in com.vaadin.flow.plugin.base: Gives access to access to plugin-spectific implementations and configurations.
pnpmEnable() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Instructs to use pnpm for installing npm frontend resources.
prepareFrontend(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil: Prepares the Frontend
productionMode() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Whether or not we are running in productionMode.
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(URL...) - Constructor for class com.vaadin.flow.server.scanner.ReflectionsClassFinder: Constructor.
requireHomeNodeExec() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Whether vaadin home node executable usage is forced.
runFrontendBuild(PluginAdapterBase) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil: Execute the frontend build with the wanted build system.
runNodeUpdater(PluginAdapterBuild) - 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 install after updating dependencies.
runVite(PluginAdapterBase, FrontendTools) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil: Runs the Vite build
runWebpack(PluginAdapterBase, FrontendTools) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil: Runs the Webpack 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.

U

updateBuildFile(PluginAdapterBuild) - Static method in class com.vaadin.flow.plugin.base.BuildFrontendUtil: Add the devMode token to build token file so we don't try to start the dev server.
useGlobalPnpm() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: Instructs to use globally installed pnpm tool or the default supported pnpm version.

W

webpackGeneratedTemplate() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild: Copy the `webpack.generated.js` from the specified URL.
webpackOutputDirectory() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBase: The folder where webpack should output index.js and other generated files.
webpackTemplate() - Method in interface com.vaadin.flow.plugin.base.PluginAdapterBuild: Copy the `webpack.config.js` from the specified URL if missing.

A B C E F G I J L N O P R S U W