Package org.gradle.api.publish.maven
Interface MavenPom
-
public interface MavenPom
The POM for a Maven publication.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 properties exposed by this class, e.g.getDescription()
. Please refer to the official POM Reference for detailed information about the individual properties.- Since:
- 1.4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
ciManagement(Action<? super MavenPomCiManagement> action)
Configures the CI management for the publication represented by this POM.void
contributors(Action<? super MavenPomContributorSpec> action)
Configures the contributors for the publication represented by this POM.void
developers(Action<? super MavenPomDeveloperSpec> action)
Configures the developers for the publication represented by this POM.void
distributionManagement(Action<? super MavenPomDistributionManagement> action)
Configures the distribution management for the publication represented by this POM.Property<String>
getDescription()
The description for the publication represented by this POM.Property<String>
getInceptionYear()
The year of the inception for the publication represented by this POM.Property<String>
getName()
The name for the publication represented by this POM.String
getPackaging()
Returns the packaging for the publication represented by this POM.Property<String>
getUrl()
The URL for the publication represented by this POM.void
issueManagement(Action<? super MavenPomIssueManagement> action)
Configures the issue management for the publication represented by this POM.void
licenses(Action<? super MavenPomLicenseSpec> action)
Configures the licenses for the publication represented by this POM.void
mailingLists(Action<? super MavenPomMailingListSpec> action)
Configures the mailing lists for the publication represented by this POM.void
organization(Action<? super MavenPomOrganization> action)
Configures the organization for the publication represented by this POM.void
scm(Action<? super MavenPomScm> action)
Configures the SCM (source control management) for the publication represented by this POM.void
setPackaging(String packaging)
Sets the packaging for the publication represented by this POM.void
withXml(Action<? super XmlProvider> action)
Allows configuration of the POM, after it has been generated according to the input data.
-
-
-
Method Detail
-
getPackaging
String getPackaging()
Returns the packaging for the publication represented by this POM.
-
setPackaging
void setPackaging(String packaging)
Sets the packaging for the publication represented by this POM.
-
getName
@Incubating Property<String> getName()
The name for the publication represented by this POM.- Since:
- 4.8
-
getDescription
@Incubating Property<String> getDescription()
The description for the publication represented by this POM.- Since:
- 4.8
-
getUrl
@Incubating Property<String> getUrl()
The URL for the publication represented by this POM.- Since:
- 4.8
-
getInceptionYear
@Incubating Property<String> getInceptionYear()
The year of the inception for the publication represented by this POM.- Since:
- 4.8
-
licenses
@Incubating void licenses(Action<? super MavenPomLicenseSpec> action)
Configures the licenses for the publication represented by this POM.- Since:
- 4.8
-
organization
@Incubating void organization(Action<? super MavenPomOrganization> action)
Configures the organization for the publication represented by this POM.- Since:
- 4.8
-
developers
@Incubating void developers(Action<? super MavenPomDeveloperSpec> action)
Configures the developers for the publication represented by this POM.- Since:
- 4.8
-
contributors
@Incubating void contributors(Action<? super MavenPomContributorSpec> action)
Configures the contributors for the publication represented by this POM.- Since:
- 4.8
-
scm
@Incubating void scm(Action<? super MavenPomScm> action)
Configures the SCM (source control management) for the publication represented by this POM.- Since:
- 4.8
-
issueManagement
@Incubating void issueManagement(Action<? super MavenPomIssueManagement> action)
Configures the issue management for the publication represented by this POM.- Since:
- 4.8
-
ciManagement
@Incubating void ciManagement(Action<? super MavenPomCiManagement> action)
Configures the CI management for the publication represented by this POM.- Since:
- 4.8
-
distributionManagement
@Incubating void distributionManagement(Action<? super MavenPomDistributionManagement> action)
Configures the distribution management for the publication represented by this POM.- Since:
- 4.8
-
mailingLists
@Incubating void mailingLists(Action<? super MavenPomMailingListSpec> action)
Configures the mailing lists for the publication represented by this POM.- Since:
- 4.8
-
withXml
void withXml(Action<? super XmlProvider> action)
Allows configuration of the POM, after it has been generated according to the input data.apply plugin: "maven-publish" publishing { publications { maven(MavenPublication) { pom.withXml { asNode().appendNode('properties').appendNode('my-property', 'my-value') } } } }
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 anAction
.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 POM reference.
- Parameters:
action
- The configuration action.- See Also:
MavenPublication
,XmlProvider
-
-