api / org.gradle.platform.base / ComponentSpec

ComponentSpec

@Incubating interface ComponentSpec : ModelElement

A software component that is built by Gradle.

Functions

getProjectPath

abstract fun getProjectPath(): String

The path to the project containing this component.

Inherited Functions

getDisplayName

abstract fun getDisplayName(): String

Returns a human-consumable display name for this element.

getName

abstract fun getName(): String

Returns the name of this element. Each element has a name associated with it, that uniquely identifies the element amongst its siblings. Some element have their name generated or automatically assigned, and for these elements the name may not be human consumable.

Inheritors

BuildableComponentSpec

interface BuildableComponentSpec : Buildable, ComponentSpec

A ComponentSpec that is directly Buildable via a specified task.

CheckableComponentSpec

interface CheckableComponentSpec : ComponentSpec

A ComponentSpec that is directly checkable via a specified task.

GeneralComponentSpec

interface GeneralComponentSpec : ComponentSpec, SourceComponentSpec, VariantComponentSpec

A general purpose component specification, that can be used to represent some software component built from source and producing multiple output variants.

JvmComponentSpec

interface JvmComponentSpec : ComponentSpec

Definition of a software component that is to be built by Gradle to run a on JVM platform.

NativeComponentSpec

interface NativeComponentSpec : ComponentSpec

Definition of a software component that is to be built by Gradle to run a on JVM platform.

SourceComponentSpec

interface SourceComponentSpec : ComponentSpec

Represents some component whose implementation can be represented as a collection of source files, and whose other outputs are built from this source.

VariantComponentSpec

interface VariantComponentSpec : ComponentSpec, VariantComponent

Represents a component spec that is made up of one or more mutually exclusive variants.