public interface IvyModuleDescriptorSpec
Corresponds to the XML version of the Ivy Module Descriptor.
The withXml(org.gradle.api.Action)
method can be used to modify the descriptor after it has been generated according to the publication data.
However, the preferred way to customize the project information to be published is to use the dedicated configuration methods exposed by this class, e.g.
description(Action)
.
Modifier and Type | Method | Description |
---|---|---|
void |
author(Action<? super IvyModuleDescriptorAuthor> action) |
Creates, configures and adds an author to this publication.
|
void |
description(Action<? super IvyModuleDescriptorDescription> action) |
Configures the description for this publication.
|
void |
extraInfo(java.lang.String namespace,
java.lang.String elementName,
java.lang.String value) |
Adds a new extra info element to the publication
|
java.lang.String |
getBranch() |
Returns the branch for this publication
|
IvyExtraInfoSpec |
getExtraInfo() |
Returns the extra info element spec for this publication
|
java.lang.String |
getStatus() |
Returns the status for this publication.
|
void |
license(Action<? super IvyModuleDescriptorLicense> action) |
Creates, configures and adds a license to this publication.
|
void |
setBranch(java.lang.String branch) |
Sets the branch for this publication
|
void |
setStatus(java.lang.String status) |
Sets the status for this publication.
|
void |
withXml(Action<? super XmlProvider> action) |
Allow configuration of the descriptor, after it has been generated according to the input data.
|
void withXml(Action<? super XmlProvider> action)
plugins { id 'ivy-publish' } publishing { publications { ivy(IvyPublication) { descriptor { withXml { asNode().dependencies.dependency.find { it.@org == "junit" }.@rev = "4.10" } } } } }Note that due to Gradle's internal type conversion system, you can pass a Groovy closure to this method and it will be automatically converted to an
Action
.
Each action/closure passed to this method will be stored as a callback, and executed when the publication that this descriptor is attached to is published.
For details on the structure of the XML to be modified, see the Ivy Module Descriptor reference.
action
- The configuration action.IvyPublication
,
XmlProvider
@Nullable java.lang.String getStatus()
void setStatus(@Nullable java.lang.String status)
@Nullable java.lang.String getBranch()
void setBranch(@Nullable java.lang.String branch)
IvyExtraInfoSpec getExtraInfo()
void extraInfo(java.lang.String namespace, java.lang.String elementName, java.lang.String value)
void license(Action<? super IvyModuleDescriptorLicense> action)
void author(Action<? super IvyModuleDescriptorAuthor> action)
void description(Action<? super IvyModuleDescriptorDescription> action)