GenerateXcodeWorkspaceFileTask (Gradle API 9.7.0)
Description: declaration: package: org.gradle.ide.xcode.tasks, class: GenerateXcodeWorkspaceFileTask

# Class GenerateXcodeWorkspaceFileTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.plugins.ide.api.GeneratorTask<org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile>
org.gradle.plugins.ide.api.XmlGeneratorTask<org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile>
org.gradle.ide.xcode.tasks.GenerateXcodeWorkspaceFileTask

All Implemented Interfaces:
  `Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable<Task>`

@Incubating @DisableCachingByDefault(because="Not made cacheable, yet") public abstract class GenerateXcodeWorkspaceFileTask extends XmlGeneratorTask<org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile>
Task for generating a Xcode workspace file (e.g. `Foo.xcworkspace/contents.xcworkspacedata`). A workspace can contain any number of Xcode projects.

Since:
  4.2
See Also:
  - `XcodeWorkspace`

- ## Nested Class Summary

  ### Nested classes/interfaces inherited from interface Named

  `Named.Namer`

- ## Field Summary

  ### Fields inherited from class GeneratorTask

  `afterConfigured, beforeConfigured, domainObject, generator`

  ### Fields inherited from interface Task

  `TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `GenerateXcodeWorkspaceFileTask()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `protected void`
  `configure(org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile workspaceFile)`
  `protected org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile`
  `create()`
  `File`
  `getInputFile()`
  The input file to load the initial configuration from.
  `FileCollection`
  `getXcodeProjectLocations()`
  `void`
  `setXcodeProjectLocations(FileCollection xcodeProjectLocations)`

  ### Methods inherited from class XmlGeneratorTask

  `getXmlTransformer`

  ### Methods inherited from class GeneratorTask

  `generate, getIncremental, getInputFileIfExists, getInstantiator, getOutputFile, setInputFile, setOutputFile`

  ### Methods inherited from class org.gradle.api.internal.ConventionTask

  `conventionMapping, conventionMapping, getConventionMapping`

  ### Methods inherited from class DefaultTask

  `compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService`

  ### Methods inherited from class org.gradle.api.internal.AbstractTask

  `acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects`

  ### Methods inherited from class Object

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

  ### Methods inherited from interface Task

  `doNotTrackState, notCompatibleWithConfigurationCache`

- ## Constructor Details

  - ### GenerateXcodeWorkspaceFileTask

    public GenerateXcodeWorkspaceFileTask()

- ## Method Details

  - ### configure

    protected void configure(org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile workspaceFile)
    Specified by:
      `configure` in class `XmlGeneratorTask<org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile>`

  - ### create

    protected org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile create()
    Specified by:
      `create` in class `XmlGeneratorTask<org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile>`

  - ### getXcodeProjectLocations

    @PathSensitive(ABSOLUTE) @InputFiles public FileCollection getXcodeProjectLocations()

  - ### setXcodeProjectLocations

    public void setXcodeProjectLocations(FileCollection xcodeProjectLocations)

  - ### getInputFile

    public File getInputFile()
    Description copied from class: `GeneratorTask`
    The input file to load the initial configuration from. Defaults to the output file. If the specified input file does not exist, this task uses some default initial configuration.
    Overrides:
      `getInputFile` in class `GeneratorTask<org.gradle.ide.xcode.tasks.internal.XcodeWorkspaceFile>`
    Returns:
      The input file.