Package org.gradle.api.plugins.jvm

Interface OutgoingElementsBuilder

@Incubating
public interface OutgoingElementsBuilder

A builder to construct an "outgoing elements" configuration, that is to say something which is consumable by other components (other projects or external projects)

Since:

6.8

Method Summary

Modifier and Type	Method	Description
OutgoingElementsBuilder	artifact(Object producer)	Registers an artifact to be attached to this configuration.
OutgoingElementsBuilder	capability(String group, String name, String version)	Explicitly declares a capability provided by this outgoing configuration
OutgoingElementsBuilder	extendsFrom(List<Provider<Configuration>> parentConfigurations)	Allows setting the configurations this outgoing elements will inherit from.
OutgoingElementsBuilder	extendsFrom(Configuration... parentConfigurations)	Allows setting the configurations this outgoing elements will inherit from.
default OutgoingElementsBuilder	extendsFrom(Provider<Configuration> configuration)	Adds this configuration as a parent configuration
OutgoingElementsBuilder	fromSourceSet(SourceSet sourceSet)	If this method is called, the outgoing elements configuration will be automatically configured to export the output of the source set.
OutgoingElementsBuilder	providesApi()	Tells that this elements configuration provides an API
OutgoingElementsBuilder	providesAttributes(Action<? super JvmEcosystemAttributesDetails> refiner)	Allows refining the attributes of this configuration in case the defaults are not sufficient.
OutgoingElementsBuilder	providesRuntime()	Tells that this elements configuration provides a runtime
OutgoingElementsBuilder	published()	Configures this outgoing variant for publication.
OutgoingElementsBuilder	withCapabilities(List<Capability> capabilities)	Allows declaring the capabilities this outgoing configuration provides
OutgoingElementsBuilder	withClassDirectoryVariant()	Configures this outgoing configuration to provides a "classes directory" variant, which is useful for intra and inter-project optimization, avoiding the creation of jar tasks when the only thing which is required is the API of a component.
OutgoingElementsBuilder	withDescription(String description)	Sets the description for this outgoing elements

Method Detail

withDescription

OutgoingElementsBuilder withDescription(String description)

Sets the description for this outgoing elements

Parameters:

description - the description

providesApi

OutgoingElementsBuilder providesApi()

Tells that this elements configuration provides an API

providesRuntime

OutgoingElementsBuilder providesRuntime()

Tells that this elements configuration provides a runtime

extendsFrom

OutgoingElementsBuilder extendsFrom(Configuration... parentConfigurations)

Allows setting the configurations this outgoing elements will inherit from. Those configurations are typically buckets of dependencies

Parameters:

parentConfigurations - the parent configurations

extendsFrom

OutgoingElementsBuilder extendsFrom(List<Provider<Configuration>> parentConfigurations)

Allows setting the configurations this outgoing elements will inherit from. Those configurations are typically buckets of dependencies

Parameters:

parentConfigurations - the parent configurations

extendsFrom

default OutgoingElementsBuilder extendsFrom(Provider<Configuration> configuration)

Adds this configuration as a parent configuration

Parameters:

configuration - the parent configuration

fromSourceSet

OutgoingElementsBuilder fromSourceSet(SourceSet sourceSet)

If this method is called, the outgoing elements configuration will be automatically configured to export the output of the source set.

Parameters:

sourceSet - the source set which consistutes an output to share with this configuration

artifact

OutgoingElementsBuilder artifact(Object producer)

Registers an artifact to be attached to this configuration. Supports anything supported by the ConfigurationPublications.artifact(Object) method, which includes task providers, or files.

Parameters:

producer - the producer

providesAttributes

OutgoingElementsBuilder providesAttributes(Action<? super JvmEcosystemAttributesDetails> refiner)

Allows refining the attributes of this configuration in case the defaults are not sufficient. The refiner will be called after the default attributes are set.

Parameters:

refiner - the attributes refiner configuration

withCapabilities

OutgoingElementsBuilder withCapabilities(List<Capability> capabilities)

Allows declaring the capabilities this outgoing configuration provides

Parameters:

capabilities - the capabilities

capability

OutgoingElementsBuilder capability(String group,
                                   String name,
                                   String version)

Explicitly declares a capability provided by this outgoing configuration

Parameters:

group - the capability group

name - the capability name

version - the capability version

withClassDirectoryVariant

OutgoingElementsBuilder withClassDirectoryVariant()

Configures this outgoing configuration to provides a "classes directory" variant, which is useful for intra and inter-project optimization, avoiding the creation of jar tasks when the only thing which is required is the API of a component. This should only be called in association with fromSourceSet(SourceSet)

published

OutgoingElementsBuilder published()

Configures this outgoing variant for publication. A published outgoing variant configured this way will be mapped to the "optional" scope, meaning that its dependencies will appear as optional in the generated POM file.