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 and Description
protected static String	ERROR_INVALID_PWA_ANNOTATION
static String	LUMO

Constructor Summary

Constructors

Constructor and Description
FrontendDependencies(ClassFinder finder) Default Constructor.
FrontendDependencies(ClassFinder finder, boolean generateEmbeddableWebComponents) Secondary constructor, which allows declaring whether embeddable web components should be checked for resource dependencies.
FrontendDependencies(ClassFinder finder, boolean generateEmbeddableWebComponents, boolean useV14Bootstrap) Tertiary constructor, which allows declaring whether embeddable web components should be checked for resource dependencies.

Method Summary

Modifier and Type	Method and Description
Set<String>	getClasses() Get all Java classes considered when looking for used dependencies.
Set<CssData>	getCss() Get all the CSS files used by the application.
Collection<EndPointData>	getEndPoints() Get all entryPoints in the application.
protected ClassFinder	getFinder()
protected Class<? extends AbstractTheme>	getLumoTheme()
List<String>	getModules() Get all ES6 modules needed for run the application.
Map<String,String>	getPackages() Get all npm packages the application depends on.
PwaConfiguration	getPwaConfiguration() Get the PWA configuration of the application.
Set<String>	getScripts() Get all the JS files used by the application.
AbstractTheme	getTheme() Get the AbstractTheme instance used in the application.
ThemeDefinition	getThemeDefinition() Get the ThemeDefinition of the application.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LUMO

public static final String LUMO

See Also:

Constant Field Values

ERROR_INVALID_PWA_ANNOTATION

protected static final String ERROR_INVALID_PWA_ANNOTATION

Constructor Detail

FrontendDependencies

public FrontendDependencies(ClassFinder finder)

Default Constructor.

Parameters:

finder - the class finder

FrontendDependencies

public FrontendDependencies(ClassFinder finder,
                            boolean generateEmbeddableWebComponents)

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

public FrontendDependencies(ClassFinder finder,
                            boolean generateEmbeddableWebComponents,
                            boolean useV14Bootstrap)

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)

useV14Bootstrap - whether we are in legacy V14 bootstrap mode

Method Detail

getPackages

public Map<String,String> getPackages()

Get all npm packages the application depends on.

Returns:

the set of npm packages

getPwaConfiguration

public PwaConfiguration getPwaConfiguration()

Get the PWA configuration of the application.

Returns:

the PWA configuration

getModules

public List<String> getModules()

Get all ES6 modules needed for run the application. Modules that are theme dependencies are guaranteed to precede other modules in the result.

Returns:

list of JS modules

getScripts

public Set<String> getScripts()

Get all the JS files used by the application.

Returns:

the set of JS files

getCss

public Set<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

getEndPoints

public Collection<EndPointData> getEndPoints()

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

toString

public String toString()

Overrides:

toString in class Object

getFinder

protected final ClassFinder getFinder()

getLumoTheme

protected Class<? extends AbstractTheme> getLumoTheme()