org.gradle.api.publish

Interface PublicationContainer

All Superinterfaces:

Collection<Publication>, DomainObjectCollection<Publication>, Iterable<Publication>, NamedDomainObjectCollection<Publication>, NamedDomainObjectSet<Publication>, Set<Publication>

@Incubating
public interface PublicationContainer
extends NamedDomainObjectSet<Publication>

A PublicationContainer is responsible for creating and managing Publication instances. The set of available publication types is dependent on the application of particular plugins:

• The MavenPublishPlugin makes it possible to create MavenPublication instances.
• The IvyPublishPlugin makes it possible to create IvyPublication instances.

See the documentation for PublishingExtension.publications(org.gradle.api.Action) for more examples of how to create and configure publications.

Since:

1.3

See Also:

Publication, PublishingExtension

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Publication> T	add(String name, Class<T> type) Creates a publication with the specified name and type, adding it to the container.
<T extends Publication> T	add(String name, Class<T> type, Action<? super T> configuration) Creates a publication with the specified name and type, adding it to the container and configuring it with the supplied action.

Methods inherited from interface org.gradle.api.NamedDomainObjectSet

findAll, matching, matching, withType

Methods inherited from interface org.gradle.api.NamedDomainObjectCollection

add, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getNamer, getRules

Methods inherited from interface org.gradle.api.DomainObjectCollection

all, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

Methods inherited from interface java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

add

<T extends Publication> T add(String name,
                            Class<T> type)
                          throws InvalidUserDataException

Creates a publication with the specified name and type, adding it to the container.

 apply plugin: 'maven-publish'

 publishing.publications.add('publication-name', MavenPublication)
 

Parameters:

name - The publication name.

type - The publication type.

Returns:

The added publication

Throws:

InvalidUserDataException - If type is not a valid publication type, or if a publication named "name" already exists.

add

<T extends Publication> T add(String name,
                            Class<T> type,
                            Action<? super T> configuration)
                          throws InvalidUserDataException

Creates a publication with the specified name and type, adding it to the container and configuring it with the supplied action. A Closure can be supplied in place of an action, through type coercion.

 apply plugin: 'ivy-publish'

 publishing.publications.add('publication-name', IvyPublication) {
     // Configure the ivy publication here
 }
 

Parameters:

name - The publication name.

type - The publication type.

configuration - The action or closure to configure the publication with.

Returns:

The added publication

Throws:

InvalidUserDataException - If type is not a valid publication type, or if a publication named "name" already exists.