Modifier and Type | Interface | Description |
---|---|---|
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 |
---|---|---|
void |
bundle(java.lang.String alias,
java.util.List<java.lang.String> aliases) |
Declares a bundle of dependencies.
|
void |
from(java.lang.Object dependencyNotation) |
Configures the model by reading it from a version catalog.
|
Property<java.lang.String> |
getDescription() |
A description for the dependencies model, which will be used in
the generated sources as documentation.
|
java.lang.String |
getLibrariesExtensionName() |
Returns the name of the extension configured by this builder
|
void |
library(java.lang.String alias,
java.lang.String groupArtifactVersion) |
Declare a library alias in full.
|
VersionCatalogBuilder.LibraryAliasBuilder |
library(java.lang.String alias,
java.lang.String group,
java.lang.String artifact) |
Entry point for registering a library alias.
|
VersionCatalogBuilder.PluginAliasBuilder |
plugin(java.lang.String alias,
java.lang.String id) |
Entry point for registering a plugin alias.
|
java.lang.String |
version(java.lang.String alias,
java.lang.String version) |
Configures a dependency version which can then be referenced using
the
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String) method. |
java.lang.String |
version(java.lang.String alias,
Action<? super MutableVersionConstraint> versionSpec) |
Configures a dependency version which can then be referenced using
the
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String) )} method. |
Property<java.lang.String> getDescription()
void from(java.lang.Object dependencyNotation)
This function can be called only once, further calls will result in an error. The passed notation should conform these constraints:
If the notation doesn't conform these constraints, an exception will be thrown at configuration time.
dependencyNotation
- any notation supported by DependencyHandler
java.lang.String version(java.lang.String alias, Action<? super MutableVersionConstraint> versionSpec)
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String)
)} method.alias
- an identifier for the versionversionSpec
- the dependency version specjava.lang.String version(java.lang.String alias, java.lang.String version)
VersionCatalogBuilder.LibraryAliasBuilder.versionRef(String)
method.alias
- an identifier for the versionversion
- the version alias nameVersionCatalogBuilder.LibraryAliasBuilder library(java.lang.String alias, java.lang.String group, java.lang.String artifact)
alias
- the alias of the librarygroup
- the group of the libraryartifact
- the artifact ID of the libraryvoid library(java.lang.String alias, java.lang.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(java.lang.String alias, java.lang.String id)
alias
- the alias of the pluginid
- the ID of the pluginvoid bundle(java.lang.String alias, java.util.List<java.lang.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)
java.lang.String getLibrariesExtensionName()