Interface VersionCatalogBuilder
- All Superinterfaces:
- Named
A version catalog builder. Dependencies defined via this model
 will trigger the generation of accessors available in build scripts.
- Since:
- 7.0
- 
Nested Class SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic interfaceAllows configuring the version of a librarystatic interfaceAllows configuring the version of a pluginNested classes/interfaces inherited from interface org.gradle.api.NamedNamed.Namer
- 
Method SummaryModifier and TypeMethodDescriptionvoidDeclares a bundle of dependencies.voidConfigures the model by reading it from a version catalog.A description for the dependencies model, which will be used in the generated sources as documentation.Returns the name of the extension configured by this buildervoidDeclare a library alias in full.Entry point for registering a library alias.Entry point for registering a plugin alias.Configures a dependency version which can then be referenced using theVersionCatalogBuilder.LibraryAliasBuilder.versionRef(String)method.version(String alias, Action<? super MutableVersionConstraint> versionSpec) Configures a dependency version which can then be referenced using theVersionCatalogBuilder.LibraryAliasBuilder.versionRef(String))} method.
- 
Method Details- 
getDescriptionA description for the dependencies model, which will be used in the generated sources as documentation.- Returns:
- the description for this model
 
- 
fromConfigures the model by reading it from a version catalog. A version catalog is a component published using the `version-catalog` plugin or a local TOML file.This function can be called only once, further calls will result in an error. The passed notation should conform these constraints: - If a file notation is passed, it should be a single file.
- If it's a resolvable dependency, it should resolve to a single file.
 If the notation doesn't conform these constraints, an exception will be thrown at configuration time. - Parameters:
- dependencyNotation- any notation supported by- DependencyHandler
 
- 
versionConfigures a dependency version which can then be referenced using theVersionCatalogBuilder.LibraryAliasBuilder.versionRef(String))} method.- Parameters:
- alias- an identifier for the version
- versionSpec- the dependency version spec
- Returns:
- the version alias name
 
- 
versionConfigures a dependency version which can then be referenced using theVersionCatalogBuilder.LibraryAliasBuilder.versionRef(String)method.- Parameters:
- alias- an identifier for the version
- version- the version alias name
 
- 
libraryEntry point for registering a library alias.- Parameters:
- alias- the alias of the library
- group- the group of the library
- artifact- the artifact ID of the library
- Returns:
- a builder for this alias, to finish the version configuration
- Since:
- 7.4
 
- 
libraryDeclare a library alias in full. This does not return a builder, as the declaration is fully complete. Uselibrary(String, String, String)if you need a more complex version declaration.Note that declaring a classifier or extension using this method is not possible. - Parameters:
- alias- the alias of the library
- groupArtifactVersion- the- group:artifact:versionstring, all components are required
- Since:
- 7.4
 
- 
pluginEntry point for registering a plugin alias.- Parameters:
- alias- the alias of the plugin
- id- the ID of the plugin
- Returns:
- a builder for this alias, to finish the version configuration
- Since:
- 7.4
 
- 
bundleDeclares a bundle of dependencies. A bundle consists of a name for the bundle, and a list of aliases. The aliases must correspond to aliases defined via thelibrary()methods.- Parameters:
- alias- the alias of the bundle
- aliases- the aliases of the dependencies included in the bundle
- See Also:
 
- 
getLibrariesExtensionNameString getLibrariesExtensionName()Returns the name of the extension configured by this builder
 
-