Package com.vaadin.flow.server.frontend.scanner

Class FrontendDependencies

java.lang.Object

com.vaadin.flow.server.frontend.scanner.FrontendDependencies

All Implemented Interfaces:

FrontendDependenciesScanner, Serializable

public class FrontendDependencies
extends Object

Represents the class dependency tree of the application.

For internal use only. May be renamed or removed in a future release.

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner

FrontendDependenciesScanner.FrontendDependenciesScannerFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ERROR_INVALID_LOAD_DEPENDENCIES_ANNOTATION
protected static final String	ERROR_INVALID_PWA_ANNOTATION
static final String	LUMO

Constructor Summary

Constructors

Constructor	Description
FrontendDependencies(ClassFinder finder)	Deprecated. Use FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) instead.
FrontendDependencies(ClassFinder finder, boolean generateEmbeddableWebComponents)	Deprecated. Use FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) instead.
FrontendDependencies(ClassFinder finder, boolean generateEmbeddableWebComponents, FeatureFlags featureFlags)	Deprecated. Use FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) instead.
FrontendDependencies(ClassFinder finder, boolean generateEmbeddableWebComponents, FeatureFlags featureFlags, boolean reactEnabled)

Method Summary

Modifier and Type	Method	Description
protected void	addValues(Map<String,List<String>> map, String key, List<String> values)
Map<String,List<String>>	getAssets()	Get all npm package assets for the application.
Set<String>	getClasses()	Get all Java classes considered when looking for used dependencies.
Map<ChunkInfo,List<CssData>>	getCss()	Get all the CSS files used by the application.
Map<String,List<String>>	getDevAssets()	Get all npm packages assets needed only for development.
Map<String,String>	getDevPackages()	Get all npm packages needed only for development.
Collection<EntryPointData>	getEntryPoints()	Get all entryPoints in the application.
protected final ClassFinder	getFinder()
protected Class<? extends AbstractTheme>	getLumoTheme()
Map<ChunkInfo,List<String>>	getModules()	Get all JS modules needed for run the application.
Map<ChunkInfo,List<String>>	getModulesDevelopment()	Get all JS modules needed in development mode.
Map<String,String>	getPackages()	Get all npm packages the application depends on.
PwaConfiguration	getPwaConfiguration()	Get the PWA configuration of the application.
Map<ChunkInfo,List<String>>	getScripts()	Get all the JS files used by the application.
Map<ChunkInfo,List<String>>	getScriptsDevelopment()	Get all the JS files needed in development mode.
AbstractTheme	getTheme()	Get the AbstractTheme instance used in the application.
ThemeDefinition	getThemeDefinition()	Get the ThemeDefinition of the application.
protected final boolean	isDisabledExperimentalClass(String className)
protected boolean	shouldVisit(String className)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LUMO

public static final String LUMO

See Also:

• Constant Field Values

ERROR_INVALID_LOAD_DEPENDENCIES_ANNOTATION

protected static final String ERROR_INVALID_LOAD_DEPENDENCIES_ANNOTATION

ERROR_INVALID_PWA_ANNOTATION

protected static final String ERROR_INVALID_PWA_ANNOTATION

Constructor Details

FrontendDependencies

@Deprecated
public FrontendDependencies(ClassFinder finder)

Deprecated.

Use FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) instead.

Default Constructor.

Parameters:

finder - the class finder

FrontendDependencies

@Deprecated
public FrontendDependencies(ClassFinder finder,
 boolean generateEmbeddableWebComponents)

Deprecated.

Use FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) instead.

Secondary constructor, which allows declaring whether embeddable web components should be checked for resource dependencies.

Parameters:

finder - the class finder

generateEmbeddableWebComponents - true checks the WebComponentExporter classes for dependencies. true is default for FrontendDependencies(ClassFinder)

FrontendDependencies

@Deprecated
public FrontendDependencies(ClassFinder finder,
 boolean generateEmbeddableWebComponents,
 FeatureFlags featureFlags)

Deprecated.

Use FrontendDependencies(ClassFinder, boolean, FeatureFlags, boolean) instead.

Tertiary constructor, which allows declaring whether embeddable web components should be checked for resource dependencies.

Parameters:

finder - the class finder

generateEmbeddableWebComponents - true checks the WebComponentExporter classes for dependencies. true is default for FrontendDependencies(ClassFinder)

featureFlags - available feature flags and their status

FrontendDependencies

public FrontendDependencies(ClassFinder finder,
 boolean generateEmbeddableWebComponents,
 FeatureFlags featureFlags,
 boolean reactEnabled)

Method Details

getPackages

public Map<String,String> getPackages()

Get all npm packages the application depends on.

Returns:

the set of npm packages

getDevPackages

public Map<String,String> getDevPackages()

Description copied from interface: FrontendDependenciesScanner

Get all npm packages needed only for development.

Returns:

the `devDependencies` packages

getAssets

public Map<String,List<String>> getAssets()

Description copied from interface: FrontendDependenciesScanner

Get all npm package assets for the application.

Returns:

the npm packages assets

getDevAssets

public Map<String,List<String>> getDevAssets()

Description copied from interface: FrontendDependenciesScanner

Get all npm packages assets needed only for development.

Returns:

the `dev` npm package assets

getPwaConfiguration

public PwaConfiguration getPwaConfiguration()

Get the PWA configuration of the application.

Returns:

the PWA configuration

getModules

public Map<ChunkInfo,List<String>> getModules()

Get all JS modules needed for run the application.

Returns:

list of JS modules

getModulesDevelopment

public Map<ChunkInfo,List<String>> getModulesDevelopment()

Get all JS modules needed in development mode.

Returns:

list of JS modules

getScripts

public Map<ChunkInfo,List<String>> getScripts()

Get all the JS files used by the application.

Returns:

the set of JS files

getScriptsDevelopment

public Map<ChunkInfo,List<String>> getScriptsDevelopment()

Get all the JS files needed in development mode.

Returns:

the set of JS files

getCss

public Map<ChunkInfo,List<CssData>> getCss()

Get all the CSS files used by the application.

Returns:

the set of CSS files

getClasses

public Set<String> getClasses()

Get all Java classes considered when looking for used dependencies.

Returns:

the set of JS files

getEntryPoints

public Collection<EntryPointData> getEntryPoints()

Get all entryPoints in the application.

Returns:

the set of JS files

getThemeDefinition

public ThemeDefinition getThemeDefinition()

Get the ThemeDefinition of the application.

Returns:

the theme definition

getTheme

public AbstractTheme getTheme()

Get the AbstractTheme instance used in the application.

Returns:

the theme instance

shouldVisit

protected boolean shouldVisit(String className)

toString

public String toString()

Overrides:

toString in class Object

getFinder

protected final ClassFinder getFinder()

isDisabledExperimentalClass

protected final boolean isDisabledExperimentalClass(String className)

getLumoTheme

protected Class<? extends AbstractTheme> getLumoTheme()

addValues

protected void addValues(Map<String,List<String>> map,
 String key,
 List<String> values)