Package com.vaadin.flow.shared.ui

Class Dependency

java.lang.Object

com.vaadin.flow.shared.ui.Dependency

All Implemented Interfaces:

Serializable

public class Dependency
extends Object
implements Serializable

Represents an html import, stylesheet or JavaScript to include on the page.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Dependency.Type	The type of a dependency.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_CONTENTS
static final String	KEY_ID
static final String	KEY_LOAD_MODE
static final String	KEY_TYPE
static final String	KEY_URL

Constructor Summary

Constructors

Constructor	Description
Dependency(Dependency.Type type, String expression)	Creates a new dependency of the given type, to be loaded using JS expression which is supposed to return a Promise.
Dependency(Dependency.Type type, String url, LoadMode loadMode)	Creates a new dependency of the given type, to be loaded from the given URL.
Dependency(Dependency.Type type, String url, LoadMode loadMode, String id)	Creates a new dependency of the given type, to be loaded from the given URL with an optional ID for tracking.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getId()	Gets the ID associated with this dependency.
LoadMode	getLoadMode()	Gets load mode that will be used for dependency loading.
Dependency.Type	getType()	Gets the type of the dependency.
String	getUrl()	Gets the untranslated URL for the dependency.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

KEY_URL

public static final String KEY_URL

See Also:

• Constant Field Values

KEY_TYPE

public static final String KEY_TYPE

See Also:

• Constant Field Values

KEY_LOAD_MODE

public static final String KEY_LOAD_MODE

See Also:

• Constant Field Values

KEY_CONTENTS

public static final String KEY_CONTENTS

See Also:

• Constant Field Values

KEY_ID

public static final String KEY_ID

See Also:

• Constant Field Values

Constructor Details

Dependency

public Dependency(Dependency.Type type,
 String url,
 LoadMode loadMode)

Creates a new dependency of the given type, to be loaded from the given URL.

The URL is passed through the translation mechanism before loading, so custom protocols, specified at VaadinUriResolver can be used.

Parameters:

type - the type of the dependency, not null

url - the URL to load the dependency from, not null

loadMode - determines dependency load mode, refer to LoadMode for details

Dependency

public Dependency(Dependency.Type type,
 String url,
 LoadMode loadMode,
 String id)

Creates a new dependency of the given type, to be loaded from the given URL with an optional ID for tracking.

The URL is passed through the translation mechanism before loading, so custom protocols, specified at VaadinUriResolver can be used.

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

Parameters:

type - the type of the dependency, not null

url - the URL to load the dependency from, not null

loadMode - determines dependency load mode, refer to LoadMode for details

id - optional ID for tracking the dependency

Dependency

public Dependency(Dependency.Type type,
 String expression)

Creates a new dependency of the given type, to be loaded using JS expression which is supposed to return a Promise.

The created instance dependency mode is LoadMode.LAZY.

Parameters:

type - the type of the dependency, not null

expression - the JS expression to load the dependency, not null

Method Details

getUrl

public String getUrl()

Gets the untranslated URL for the dependency.

Returns:

the URL for the dependency

getType

public Dependency.Type getType()

Gets the type of the dependency.

Returns:

the type of the dependency

getLoadMode

public LoadMode getLoadMode()

Gets load mode that will be used for dependency loading. Refer to LoadMode for details.

Returns:

the load mode that will be used during dependency loading

getId

public String getId()

Gets the ID associated with this dependency.

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

Returns:

the dependency ID or null if not set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object