gradle/org.gradle.api.artifacts/VersionCatalog

VersionCatalog

@NonNullApi
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

Link copied to clipboard
abstract fun findBundle(alias: String): Optional<Provider<ExternalModuleDependencyBundle>>
Returns the provider for the corresponding bundle alias.
Link copied to clipboard
abstract fun findLibrary(alias: String): Optional<Provider<MinimalExternalModuleDependency>>
Returns the dependency provider for the corresponding library alias.
Link copied to clipboard
abstract fun findPlugin(alias: String): Optional<Provider<PluginDependency>>
Returns the plugin dependency provider for the requested alias.
Link copied to clipboard
abstract fun findVersion(alias: String): Optional<VersionConstraint>
Returns the version constraint with the corresponding alias in the catalog.
Link copied to clipboard
abstract fun getBundleAliases(): List<String>
Returns the list of bundles defined in this version catalog.
Link copied to clipboard
abstract fun getLibraryAliases(): List<String>
Returns the list of aliases defined in this version catalog.
Link copied to clipboard
abstract fun getName(): String
Link copied to clipboard
abstract fun getPluginAliases(): List<String>
Returns the list of plugin aliases defined in this version catalog.
Link copied to clipboard
abstract fun getVersionAliases(): List<String>
Returns the list of version aliases defined in this version catalog.