Package org.gradle.api.artifacts
Interface MutableVersionConstraint
-
- All Superinterfaces:
Describable,VersionConstraint
@Incubating public interface MutableVersionConstraint extends VersionConstraint
A configurable version constraint. This is exposed to the build author, so that one can express more constraints on a version,- Since:
- 4.4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetBranch()Returns the branch to select versions from.voidprefer(String version)Sets the preferred version of this module.voidreject(String... versions)Declares a list of rejected versions.voidrejectAll()Rejects all versions of this component.voidrequire(String version)Sets the required version of this module.voidsetBranch(String branch)Specifies the branch to select versions from.voidstrictly(String version)Sets the version as strict, meaning that if any other dependency version for this module disagrees with this version, resolution will fail.-
Methods inherited from interface org.gradle.api.Describable
getDisplayName
-
Methods inherited from interface org.gradle.api.artifacts.VersionConstraint
getPreferredVersion, getRejectedVersions, getRequiredVersion, getStrictVersion
-
-
-
-
Method Detail
-
getBranch
@Nullable String getBranch()
Returns the branch to select versions from. When notnull, select only versions that were built from the given branch.- Specified by:
getBranchin interfaceVersionConstraint- Since:
- 4.6
-
setBranch
void setBranch(@Nullable String branch)
Specifies the branch to select versions from.- Parameters:
branch- The branch, possibly null.- Since:
- 4.6
-
require
void require(String version)
Sets the required version of this module. Any other version constraints will be overriden.- Parameters:
version- the required version of this module- Since:
- 5.0
-
prefer
void prefer(String version)
Sets the preferred version of this module. Any other version constraints will be overriden.- Parameters:
version- the preferred version of this module
-
strictly
void strictly(String version)
Sets the version as strict, meaning that if any other dependency version for this module disagrees with this version, resolution will fail. Any other version constraints will be overriden.- Parameters:
version- the strict version to be used for this module
-
reject
void reject(String... versions)
Declares a list of rejected versions. If such a version is found during dependency resolution, it will not be selected.- Parameters:
versions- the rejected versions- Since:
- 4.5
-
rejectAll
void rejectAll()
Rejects all versions of this component. Can be used to declare that a component is incompatible with another (typically, cannot have both a 2 different implementations of the same API).- Since:
- 4.5
-
-