com.vaadin.flow.plugin.common

Class FrontendDataProvider

java.lang.Object

com.vaadin.flow.plugin.common.FrontendDataProvider

public class FrontendDataProvider
extends Object

Provides necessary data for FrontendToolsManager to process project frontend files.

Since:

1.0.

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
FrontendDataProvider(boolean shouldBundle, boolean shouldMinify, boolean shouldHash, File es6SourceDirectory, AnnotationValuesExtractor annotationValuesExtractor, File fragmentConfigurationFile, String webComponentOutputDirectoryName, Map<String,Set<String>> userDefinedFragments) Creates the data provider.

Method Summary

Modifier and Type	Method and Description
Set<String>	createFragmentFiles(File targetDirectory) If bundling is enabled, creates fragment files required for the bundling, if any were configured.
String	createShellFile(File targetDirectory) Creates a shell file that contains all application imports excluding the ones included into fragments (if any).
protected ThemedURLTranslator	getTranslator(File es6SourceDirectory, com.vaadin.flow.migration.ClassPathIntrospector introspector) Gets the URL translator to rewrite URL using the theme in declared in the application.
protected WebComponentModulesGenerator	getWebComponentGenerator(com.vaadin.flow.migration.ClassPathIntrospector introspector) Gets web component module content generator.
boolean	shouldBundle() Gets the information whether should the plugin bundle the frontend files or not.
boolean	shouldHash() Gets the information whether should the plugin rename the output files by adding a hash fragment.
boolean	shouldMinify() Gets the information whether should the plugin minify the output files or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

FrontendDataProvider

public FrontendDataProvider(boolean shouldBundle,
                            boolean shouldMinify,
                            boolean shouldHash,
                            File es6SourceDirectory,
                            AnnotationValuesExtractor annotationValuesExtractor,
                            File fragmentConfigurationFile,
                            String webComponentOutputDirectoryName,
                            Map<String,Set<String>> userDefinedFragments)

Creates the data provider.

Parameters:

shouldBundle - whether bundling data should be prepared

shouldMinify - whether the output files should be minified

shouldHash - whether the output file names should containt a fingerprint

es6SourceDirectory - the directory with original ES6 files, not null

annotationValuesExtractor - extractor for getting all required values from project to prepare its resources properly, not null

fragmentConfigurationFile - path to external configuration file with fragments, may be null

webComponentOutputDirectoryName - folder name inside es6SourceDirectory where web component module files will be generated, not null

userDefinedFragments - another list of fragments, if user preferred to specify them without external configuration file, not null

Method Detail

shouldBundle

public boolean shouldBundle()

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

Returns:

true if bundling should be performed, false otherwise

shouldMinify

public boolean shouldMinify()

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

Returns:

true if minification should be performed, false otherwise

shouldHash

public boolean shouldHash()

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

Returns:

true if renaming of fragments to include a hash part should be performed

createFragmentFiles

public Set<String> createFragmentFiles(File targetDirectory)

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

Parameters:

targetDirectory - the directory to create the files into

Returns:

absolute paths of the files created

createShellFile

public String createShellFile(File targetDirectory)

Creates a shell file that contains all application imports excluding the ones included into fragments (if any). Used by the FrontendToolsManager to process the application files

Parameters:

targetDirectory - the directory to create the file into

Returns:

an absolute path to the file created

getTranslator

protected ThemedURLTranslator getTranslator(File es6SourceDirectory,
                                            com.vaadin.flow.migration.ClassPathIntrospector introspector)

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

Parameters:

es6SourceDirectory - the directory with original ES6 files, not null

introspector - the introspector whose classpath will be used for returned translator

Returns:

the translator which rewrites URLs using the application theme

getWebComponentGenerator

protected WebComponentModulesGenerator getWebComponentGenerator(com.vaadin.flow.migration.ClassPathIntrospector introspector)

Gets web component module content generator.

Parameters:

introspector - the introspector whose classpath will be used for returned generator

Returns:

the web component module content generator