Package com.vaadin.flow.component.internal

Class DependencyList

java.lang.Object

com.vaadin.flow.component.internal.DependencyList

All Implemented Interfaces:

Serializable

public class DependencyList
extends Object
implements Serializable

List for storing dependencies/files (JavaScript, Stylesheets) to be loaded and included on the client side.

Tracks previously sent URLs and doesn't send them again.

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

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DependencyList()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	add(Dependency dependency)	Adds the given dependency to be loaded by the client side.
void	clearPendingSendToClient()	Clears the list of dependencies which should be sent to the client.
Dependency	getDependencyByUrl(String url, Dependency.Type type)	Gets a dependency by its URL and type.
Collection<Dependency>	getPendingSendToClient()	Returns a list of dependencies which should be sent to the client.
boolean	remove(String dependencyId)	Removes a dependency by its ID.

Methods inherited from class java.lang.Object

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

Constructor Details

DependencyList

public DependencyList()

Creates a new instance.

Method Details

add

public void add(Dependency dependency)

Adds the given dependency to be loaded by the client side.

Does not send any previously sent dependencies again.

Relative URLs are interpreted as relative to the configured frontend directory location. You can prefix the URL with context:// to make it relative to the context path or use an absolute URL to refer to files outside the frontend directory.

Parameters:

dependency - the dependency to include on the page

getPendingSendToClient

public Collection<Dependency> getPendingSendToClient()

Returns a list of dependencies which should be sent to the client.

Returns:

a list containing the dependencies which should be sent

clearPendingSendToClient

public void clearPendingSendToClient()

Clears the list of dependencies which should be sent to the client.

getDependencyByUrl

public Dependency getDependencyByUrl(String url,
 Dependency.Type type)

Gets a dependency by its URL and type.

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

Parameters:

url - the URL of the dependency

type - the type of the dependency

Returns:

the dependency, or null if not found

remove

public boolean remove(String dependencyId)

Removes a dependency by its ID.

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

Parameters:

dependencyId - the ID of the dependency to remove

Returns:

true if the dependency was removed, false if it wasn't found