api / org.gradle.api.artifacts / VersionConstraint

VersionConstraint

@Incubating interface VersionConstraint

Represents a constrained version. By default, when a dependency has a version number, it is assumed that the version can be upgraded during conflict resolution (typically, version 1.15 can be upgraded to 1.16). However in some cases we don't want this behavior. This class represents the base spec of module constraints.

Since
4.4

Functions

getBranch

abstract fun getBranch(): String

The branch to select versions from. When not null selects only those versions that were built from the specified branch.

getPreferredVersion

abstract fun getPreferredVersion(): String

The preferred version of a module. The preferred version of a module can typically be upgraded during dependency resolution, unless further constraints are added.

getRejectedVersions

abstract fun getRejectedVersions(): MutableList<String>

Returns the list of versions that this module rejects (which may be exact versions, or ranges, anything that fits into a version string).

Inheritors

MutableVersionConstraint

interface MutableVersionConstraint : VersionConstraint

A configurable version constraint. This is exposed to the build author, so that one can express more constraints on a version,