| Modifier and Type | Interface | Description |
|---|---|---|
static interface |
VersionCatalogBuilder.AliasBuilder |
Deprecated.
With the removal of
alias(String), this class will no longer needed. |
static interface |
VersionCatalogBuilder.LibraryAliasBuilder |
Allows configuring the version of a library
|
static interface |
VersionCatalogBuilder.PluginAliasBuilder |
Allows configuring the version of a plugin
|
Named.Namer| Modifier and Type | Method | Description |
|---|---|---|
VersionCatalogBuilder.AliasBuilder |
alias(String alias) |
Deprecated.
|
void |
bundle(String alias,
List<String> aliases) |
Declares a bundle of dependencies.
|
void |
from(Object dependencyNotation) |
Configures the model by reading it from a version catalog.
|
Property<String> |
getDescription() |
A description for the dependencies model, which will be used in
the generated sources as documentation.
|
String |
getLibrariesExtensionName() |
Returns the name of the extension configured by this builder
|
void |
library(String alias,
String groupArtifactVersion) |
Declare a library alias in full.
|
VersionCatalogBuilder.LibraryAliasBuilder |
library(String alias,
String group,
String artifact) |
Entry point for registering a library alias.
|
VersionCatalogBuilder.PluginAliasBuilder |
plugin(String alias,
String id) |
Entry point for registering a plugin alias.
|
String |
version(String alias,
String version) |
Configures a dependency version which can then be referenced using
the
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String) method. |
String |
version(String alias,
Action<? super MutableVersionConstraint> versionSpec) |
Configures a dependency version which can then be referenced using
the
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String) )} method. |
Property<String> getDescription()
void from(Object dependencyNotation)
dependencyNotation - any notation supported by DependencyHandlerString version(String alias, Action<? super MutableVersionConstraint> versionSpec)
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String) )} method.alias - an identifier for the versionversionSpec - the dependency version specString version(String alias, String version)
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String) method.alias - an identifier for the versionversion - the version alias name@Deprecated VersionCatalogBuilder.AliasBuilder alias(String alias)
library(String, String, String), library(String, String)
and plugin(String, String) instead. Will be removed in Gradle 8.alias - the alias identiferVersionCatalogBuilder.LibraryAliasBuilder library(String alias, String group, String artifact)
alias - the alias of the librarygroup - the group of the libraryartifact - the artifact ID of the libraryvoid library(String alias, String groupArtifactVersion)
library(String, String, String) if you need a more complex version declaration.
Note that declaring a classifier or extension using this method is not possible.
alias - the alias of the librarygroupArtifactVersion - the group:artifact:version string, all components are requiredVersionCatalogBuilder.PluginAliasBuilder plugin(String alias, String id)
alias - the alias of the pluginid - the ID of the pluginvoid bundle(String alias, List<String> aliases)
library() methods.alias - the alias of the bundlealiases - the aliases of the dependencies included in the bundlelibrary(String, String, String),
library(String, String)String getLibrariesExtensionName()