io.spine.tools.gradle.project

Class DependantProject

java.lang.Object

io.spine.tools.gradle.project.DependantProject

All Implemented Interfaces:

Dependant

public final class DependantProject
extends java.lang.Object
implements Dependant

A Dependant implemented on top of a DependencyHandler of a project.

Method Summary

Modifier and Type	Method and Description
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.
static DependantProject	from(org.gradle.api.Project project) Creates a new instance of DependantProject for the given project.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.tools.gradle.project.Dependant

compile, compile, implementation

Method Detail

from

public static DependantProject from(org.gradle.api.Project project)

Creates a new instance of DependantProject for the given project.

depend

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

Description copied from interface: Dependant

Adds a new dependency within a given configuration.

Specified by:

depend in interface Dependant

Parameters:

configurationName - the name of the Gradle configuration

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

exclude

public void exclude(Dependency dependency)

Description copied from interface: Dependant

Excludes the given dependency from the project.

Specified by:

exclude in interface Dependant

Parameters:

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

force

public void force(Artifact artifact)

Description copied from interface: Dependant

Forces all project configurations to fetch the particular dependency version.

Specified by:

force in interface Dependant

Parameters:

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

force

public void force(java.lang.String notation)

Description copied from interface: Dependant

Forces all project configurations to fetch the particular dependency version.

Specified by:

force in interface Dependant

Parameters:

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

removeForcedDependency

public void removeForcedDependency(Dependency dependency)

Description copied from interface: Dependant

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

Specified by:

removeForcedDependency in interface Dependant

Parameters:

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

removeForcedDependency

public void removeForcedDependency(java.lang.String notation)

Description copied from interface: Dependant

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

Specified by:

removeForcedDependency in interface Dependant

Parameters:

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