gradle/org.gradle.api.artifacts/VersionCatalog

VersionCatalog

interface VersionCatalog : Named(source)

Provides access to a version catalog. Unlike generated extension classes for catalogs, there is no guarantee that the requested aliases exist, so you must check existence on the returned optional values.

Since

7.0

Functions

findBundle

abstract fun findBundle(alias: String): Optional<Provider<ExternalModuleDependencyBundle>>

Returns the provider for the corresponding bundle alias.

findLibrary

abstract fun findLibrary(alias: String): Optional<Provider<MinimalExternalModuleDependency>>

Returns the dependency provider for the corresponding library alias.

findPlugin

abstract fun findPlugin(alias: String): Optional<Provider<PluginDependency>>

Returns the plugin dependency provider for the requested alias.

findVersion

abstract fun findVersion(alias: String): Optional<VersionConstraint>

Returns the version constraint with the corresponding alias in the catalog.

getBundleAliases

abstract fun getBundleAliases(): List<String>

Returns the list of bundles defined in this version catalog.

getLibraryAliases

abstract fun getLibraryAliases(): List<String>

Returns the list of aliases defined in this version catalog.

getName

abstract fun getName(): String

getPluginAliases

abstract fun getPluginAliases(): List<String>

Returns the list of plugin aliases defined in this version catalog.

getVersionAliases

abstract fun getVersionAliases(): List<String>

Returns the list of version aliases defined in this version catalog.