io.spine.tools.gradle.project

Interface Dependant

All Known Implementing Classes:

DependantProject

public interface Dependant

Manages the dependencies of a Gradle project.

Typically, represented by a DependencyHandler of the project.

Method Summary

Modifier and Type	Method and Description
default void	compile(Artifact artifact) Adds a new dependency within the compile configuration.
default void	compile(java.lang.String notation) Adds a new dependency within the compile configuration.
void	depend(ConfigurationName configurationName, java.lang.String notation) Adds a new dependency within a given configuration.
void	exclude(Dependency dependency) Excludes the given dependency from the project.
void	force(Artifact artifact) Forces all project configurations to fetch the particular dependency version.
void	force(java.lang.String notation) Forces all project configurations to fetch the particular dependency version.
default void	implementation(java.lang.String notation) Adds a new dependency within the implementation configuration.
void	removeForcedDependency(Dependency dependency) Removes a forced dependency from resolution strategies of all project configurations.
void	removeForcedDependency(java.lang.String notation) Removes a forced dependency from resolution strategies of all project configurations.

Method Detail

depend

void depend(ConfigurationName configurationName,
            java.lang.String notation)

Adds a new dependency within a given configuration.

Parameters:

configurationName - the name of the Gradle configuration

notation - the dependency string, e.g. "io.spine:spine-base:1.0.0"

exclude

void exclude(Dependency dependency)

Excludes the given dependency from the project.

Parameters:

dependency - the dependency to exclude, may refer to multiple artifacts with different versions, classifiers, etc.

force

void force(Artifact artifact)

Forces all project configurations to fetch the particular dependency version.

Parameters:

artifact - the artifact which represents a dependency resolved to the required version

force

void force(java.lang.String notation)

Forces all project configurations to fetch the particular dependency version.

Parameters:

notation - the dependency spec, e.g. com.google.protobuf:protoc:3.9.0

removeForcedDependency

void removeForcedDependency(Dependency dependency)

Removes a forced dependency from resolution strategies of all project configurations.

Parameters:

dependency - the dependency to remove from the list of forced dependencies

removeForcedDependency

void removeForcedDependency(java.lang.String notation)

Removes a forced dependency from resolution strategies of all project configurations.

Parameters:

notation - the dependency spec, e.g. com.google.protobuf:protoc:3.9.0

compile

default void compile(Artifact artifact)

Adds a new dependency within the compile configuration.

See Also:

compile(String)

compile

default void compile(java.lang.String notation)

Adds a new dependency within the compile configuration.

Though compile configuration is deprecated in Gradle, it is still used in order to define Protobuf dependencies without re-generating the Java/JS sources from the upstream Protobuf definitions.

See Also:

depend(ConfigurationName, String)

implementation

default void implementation(java.lang.String notation)

Adds a new dependency within the implementation configuration.

See Also:

depend(ConfigurationName, String)