dev.nokee.ide.xcode

Interface XcodeIdeTarget

All Superinterfaces:

Named

public interface XcodeIdeTarget
extends Named

Represents a Xcode IDE target.

A target specifies a product to build and contains the instructions for building the product from a set of files in a project or workspace. A target defines a single product; it organizes the inputs into the build system—the source files and instructions for processing those source files—required to build that product. Projects can contain one or more targets, each of which produces one product.

—Xcode Targets Concept

Since:

0.3

See Also:

Xcode Targets Concept

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Method Summary

Modifier and Type	Method and Description
void	buildConfigurations(Action<? super NamedDomainObjectContainer<XcodeIdeBuildConfiguration>> action) Configures the build configuration container with the specified action.
NamedDomainObjectContainer<XcodeIdeBuildConfiguration>	getBuildConfigurations() Returns the build configurations this target can build.
XcodeIdeTarget	getIdeTarget() Returns this Xcode target instance.
Property<String>	getProductName() Returns the product name this target is building.
Property<String>	getProductReference() Returns the reference filename of the product.
Property<XcodeIdeProductType>	getProductType() Returns the product type this target is building.
ConfigurableFileCollection	getSources() Returns the sources this target will build.

Methods inherited from interface org.gradle.api.Named

getName

Method Detail

getProductName

Property<String> getProductName()

Returns the product name this target is building. Typically, the product name is the base name of the produce reference.

Returns:

a property to configure the target's product name, never null.

getProductType

Property<XcodeIdeProductType> getProductType()

Returns the product type this target is building. Instances of XcodeIdeProductType are available via XcodeIdeProductTypes constants or via the XcodeIdeProjectExtension.getProductTypes() factory.

Returns:

a property to configure the target's product type, never null.

See Also:

XcodeIdeProductType, XcodeIdeProductTypes

getProductReference

Property<String> getProductReference()

Returns the reference filename of the product. The reference refers to the file name and extension of the built product.

Returns:

a property to configure the target's product filename.

getBuildConfigurations

NamedDomainObjectContainer<XcodeIdeBuildConfiguration> getBuildConfigurations()

Returns the build configurations this target can build.

Returns:

a container of XcodeIdeBuildConfiguration to configure the build configuration for this target, never null.

buildConfigurations

void buildConfigurations(Action<? super NamedDomainObjectContainer<XcodeIdeBuildConfiguration>> action)

Configures the build configuration container with the specified action.

Parameters:

action - a configuration action for the container of XcodeIdeBuildConfiguration instances.

Throws:

NullPointerException - if the action is null

getSources

ConfigurableFileCollection getSources()

Returns the sources this target will build.

Returns:

a file collection to configure the sources for this target, never null.

getIdeTarget

XcodeIdeTarget getIdeTarget()

Returns this Xcode target instance. This method is offered for convenience when configuring Xcode IDE via the build DSL.

Returns:

this XcodeIdeTarget instance, never null.