dev.nokee.ide.xcode

Interface XcodeIdeProject

All Superinterfaces:

IdeProject, IdeProjectReference, Named, XcodeIdeProjectReference

public interface XcodeIdeProject
extends IdeProject, Named, XcodeIdeProjectReference

Represents a Xcode IDE project.

An Xcode project is a repository for all the files, resources, and information required to build one or more software products. A project contains all the elements used to build your products and maintains the relationships between those elements. It contains one or more targets, which specify how to build products. A project defines default build settings for all the targets in the project (each target can also specify its own build settings, which override the project build settings).

—Xcode Projects Concept

It is assumed that each project will delegate to Gradle for building. The generated Xcode projects act as a bridge to allow a native Xcode IDE experience.

Since:

0.3

See Also:

Xcode Projects Concept

Nested Class Summary

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

Named.Namer

Method Summary

Modifier and Type	Method and Description
NamedDomainObjectContainer<XcodeIdeGroup>	getGroups() Returns the source groups for this project.
XcodeIdeProject	getIdeProject() Returns this Xcode project instance.
Provider<FileSystemLocation>	getLocation() Returns the location of the generated project.
ConfigurableFileCollection	getSources() Returns the sources to include in the main group of this project.
NamedDomainObjectContainer<XcodeIdeTarget>	getTargets() Returns the targets for this project.
void	groups(Action<? super NamedDomainObjectContainer<XcodeIdeGroup>> action) Configures the group container with the specified action.
void	targets(Action<? super NamedDomainObjectContainer<XcodeIdeTarget>> action) Configures the target container with the specified action.

Methods inherited from interface org.gradle.api.Named

getName

Method Detail

getLocation

Provider<FileSystemLocation> getLocation()

Returns the location of the generated project. It defaults to

${project.projectDir}/${project.name}.xcodeproj

.

Specified by:

getLocation in interface IdeProject

Specified by:

getLocation in interface XcodeIdeProjectReference

Returns:

a provider to the location of the generated project.

getTargets

NamedDomainObjectContainer<XcodeIdeTarget> getTargets()

Returns the targets for this project.

Returns:

a container of XcodeIdeTarget to configure the target, never null.

targets

void targets(Action<? super NamedDomainObjectContainer<XcodeIdeTarget>> action)

Configures the target container with the specified action.

Parameters:

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

Throws:

NullPointerException - if the action is null

getGroups

NamedDomainObjectContainer<XcodeIdeGroup> getGroups()

Returns the source groups for this project.

Returns:

a container of XcodeIdeGroup to configure the group, never null.

groups

void groups(Action<? super NamedDomainObjectContainer<XcodeIdeGroup>> action)

Configures the group container with the specified action.

Parameters:

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

Throws:

NullPointerException - if the action is null

getSources

ConfigurableFileCollection getSources()

Returns the sources to include in the main group of this project.

Returns:

a file collection to configure the sources for main group of this project, never null.

getIdeProject

XcodeIdeProject getIdeProject()

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

Returns:

this XcodeIdeProject instance, never null.