Groovy Documentation

org.gradle.api.publish.ivy
[Java] Interface IvyModuleDescriptor


@Incubating
@HasInternalProtocol
public interface IvyModuleDescriptor

The descriptor of any Ivy publication.

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.

Since:
1.3


Method Summary
File getFile()

The generated descriptor file.

void setFile(File descriptorFile)

Sets where the descriptor file should be generated.

void withXml(Action action)

Allow configuration of the descriptor, after it has been generated according to the input data.

 

Method Detail

getFile

public File getFile()
The generated descriptor file. This file will only exist after the publishing task that publishing the publication this descriptor is part of.
Returns:
The generated descriptor file


setFile

public void setFile(File descriptorFile)
Sets where the descriptor file should be generated.
Parameters:
descriptorFile - The new location to generate the descriptor to


withXml

public void withXml(Action action)
Allow configuration of the descriptor, after it has been generated according to the input data.
 apply plugin: "ivy-publish"

 publishing {
   publications {
     ivy {
       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.

Parameters:
action - The configuration action.
See Also:
IvyPublication
XmlProvider


 

Gradle API 1.3