org.gradle.api.publish.maven.MavenPom Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.publish.maven;
import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.XmlProvider;
import org.gradle.api.provider.Property;
import org.gradle.internal.HasInternalProtocol;
/**
* The POM for a Maven publication.
*
* The {@link #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.
* {@link #getDescription()}. Please refer to the official
* POM Reference for detailed
* information about the individual properties.
*
* @since 1.4
*/
@HasInternalProtocol
public interface MavenPom {
/**
* Returns the packaging for the publication represented by this POM.
*/
String getPackaging();
/**
* Sets the packaging for the publication represented by this POM.
*/
void setPackaging(String packaging);
/**
* The name for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
Property getName();
/**
* The description for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
Property getDescription();
/**
* The URL for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
Property getUrl();
/**
* The year of the inception for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
Property getInceptionYear();
/**
* Configures the licenses for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void licenses(Action action);
/**
* Configures the organization for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void organization(Action action);
/**
* Configures the developers for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void developers(Action action);
/**
* Configures the contributors for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void contributors(Action action);
/**
* Configures the SCM (source control management) for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void scm(Action action);
/**
* Configures the issue management for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void issueManagement(Action action);
/**
* Configures the CI management for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void ciManagement(Action action);
/**
* Configures the distribution management for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void distributionManagement(Action action);
/**
* Configures the mailing lists for the publication represented by this POM.
*
* @since 4.8
*/
@Incubating
void mailingLists(Action 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 an {@code 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 POM reference.
*
* @param action The configuration action.
* @see MavenPublication
* @see XmlProvider
*/
void withXml(Action action);
}