ca.mestevens.ios

Class XcodeBuildMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ca.mestevens.ios.XcodeBuildMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="xcode-build",
      defaultPhase=COMPILE)
public class XcodeBuildMojo
extends org.apache.maven.plugin.AbstractMojo

Goal to build your artifact.

Field Summary

Fields

Modifier and Type	Field and Description
String	artifactName The name of the artifact.
boolean	buildDevice Property to determine whether or not to build for device.
Map<String,String>	buildSettings A map of build settings to add.
boolean	buildSimulator Property to determine whether or not to build for the simulator.
List<String>	deviceArchs The list of device architectures to build.
boolean	forceCodeSigning
ProcessRunner	processRunner
org.apache.maven.project.MavenProject	project
List<String>	simulatorArchs The list of simulator architectures to build.
String	targetDirectory
Map<String,String>	userDefaults A map of user defaults to add.
boolean	xcodeAllTargets Build all the targets in the specified project.
String	xcodebuild The location of the xcodebuild executable.
String	xcodeConfigurationName Use the specified build configuration when building each target.
String	xcodeDerivedDataPath Overrides the folder that should be used for derived data when performing a build action on a scheme in a workspace.
Integer	xcodeDestinationTimeout Use the specified timeout when searching for a destination device.
String	xcodeProject The path to your xcodeproj file.
String	xcodeResultBundlePath Writes a bundle to the specified path with results from performing a build action on a scheme in a workspace.
String	xcodeScheme The name of the scheme to build.
boolean	xcodeSkipUnavailableActions Skip build actions that cannot be performed instead of failing.
String	xcodeTarget Builds the specified target.
String	xcodeWorkspace Build the specified workspace.
String	xcodeXcconfig Load the build settings defined in the specified file when building all targets.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
XcodeBuildMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkReturnValue(int returnValue)
protected List<String>	createCommonBuildCommands()
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

project

@Parameter(property="project",
           readonly=true,
           required=true)
public org.apache.maven.project.MavenProject project

xcodebuild

@Parameter(alias="xcodebuildPath",
           property="xcodebuild.path",
           defaultValue="/usr/bin/xcodebuild",
           required=true)
public String xcodebuild

The location of the xcodebuild executable. Defaults to /usr/bin/xcodebuild.

xcodeProject

@Parameter(alias="project",
           property="xcode.project.path",
           defaultValue="${basedir}/${project.artifactId}.xcodeproj",
           required=true)
public String xcodeProject

The path to your xcodeproj file. Defaults to ${basedir}/${project.artifactId}.xcodeproj.

xcodeTarget

@Parameter(alias="target",
           property="xcode.project.target",
           required=false)
public String xcodeTarget

Builds the specified target.

xcodeAllTargets

@Parameter(alias="allTargets",
           property="xcode.project.all.targets",
           required=false)
public boolean xcodeAllTargets

Build all the targets in the specified project.

xcodeWorkspace

@Parameter(alias="workspace",
           property="xcode.project.workspace",
           required=false)
public String xcodeWorkspace

Build the specified workspace.

xcodeScheme

@Parameter(alias="scheme",
           property="xcode.project.scheme",
           defaultValue="${project.artifactId}",
           required=true)
public String xcodeScheme

The name of the scheme to build. Defaults to ${project.artifactId}.

xcodeDestinationTimeout

@Parameter(alias="destinationTimeout",
           property="xcode.project.destination.timeout",
           required=false)
public Integer xcodeDestinationTimeout

Use the specified timeout when searching for a destination device. The default is 30 seconds.

xcodeConfigurationName

@Parameter(alias="configuration",
           property="xcode.project.configuration.name",
           required=false)
public String xcodeConfigurationName

Use the specified build configuration when building each target.

xcodeDerivedDataPath

@Parameter(alias="derivedDataPath",
           property="xcode.project.derived.data.path",
           required=false)
public String xcodeDerivedDataPath

Overrides the folder that should be used for derived data when performing a build action on a scheme in a workspace.

xcodeResultBundlePath

@Parameter(alias="resultBundlePath",
           property="xcode.project.result.bundle.path",
           required=false)
public String xcodeResultBundlePath

Writes a bundle to the specified path with results from performing a build action on a scheme in a workspace.

xcodeXcconfig

@Parameter(alias="xcconfig",
           property="xcode.project.xcconfig.file.name",
           required=false)
public String xcodeXcconfig

Load the build settings defined in the specified file when building all targets. These settings will over-ride all other settings, including settings passed individually on the command line.

xcodeSkipUnavailableActions

@Parameter(alias="skipUnavailableActions",
           property="xcode.project.skip.unavailable.actions",
           defaultValue="false",
           required=false)
public boolean xcodeSkipUnavailableActions

Skip build actions that cannot be performed instead of failing.

targetDirectory

@Parameter(property="project.build.directory",
           readonly=true,
           required=true)
public String targetDirectory

artifactName

@Parameter(alias="xcodeProjectArtifactName",
           property="xcode.artifact.name",
           defaultValue="${project.artifactId}",
           required=true)
public String artifactName

The name of the artifact. Defaults to ${project.artifactId}

simulatorArchs

@Parameter
public List<String> simulatorArchs

The list of simulator architectures to build.

deviceArchs

@Parameter
public List<String> deviceArchs

The list of device architectures to build.

buildSettings

@Parameter
public Map<String,String> buildSettings

A map of build settings to add.

userDefaults

@Parameter
public Map<String,String> userDefaults

A map of user defaults to add.

buildSimulator

@Parameter(alias="buildSimulator",
           property="xcode.project.build.simulator",
           defaultValue="true",
           required=false)
public boolean buildSimulator

Property to determine whether or not to build for the simulator.

buildDevice

@Parameter(alias="buildDevice",
           property="xcode.project.build.device",
           defaultValue="true",
           required=false)
public boolean buildDevice

Property to determine whether or not to build for device.

forceCodeSigning

@Parameter(alias="forceCodeSigning",
           property="xcode.project.force.code.signing",
           defaultValue="false",
           required=false)
public boolean forceCodeSigning

processRunner

public ProcessRunner processRunner

Constructor Detail

XcodeBuildMojo

public XcodeBuildMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

checkReturnValue

protected void checkReturnValue(int returnValue)
                         throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

createCommonBuildCommands

protected List<String> createCommonBuildCommands()