Groovy Documentation

org.gradle.plugins.ide.eclipse
[Groovy] Class GenerateEclipseProject

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.plugins.ide.api.XmlGeneratorTask
                      org.gradle.plugins.ide.eclipse.GenerateEclipseProject

class GenerateEclipseProject
extends XmlGeneratorTask

Generates an Eclipse .project file. If you want to fine tune the eclipse configuration

At this moment nearly all configuration is done via EclipseProject.

Authors:
Hans Dockter


Field Summary
 
Fields inherited from class GeneratorTask
afterConfigured, beforeConfigured, domainObject, generator
 
Fields inherited from class org.gradle.api.internal.ConventionTask
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION
 
Property Summary
EclipseProject projectModel

model for eclipse project (.project) generation

 
Constructor Summary
GenerateEclipseProject()

 
Method Summary
void buildCommand(java.util.Map args, java.lang.String buildCommand)

Deprecated.

void buildCommand(java.lang.String buildCommand)

Deprecated.

protected void configure(Project project)

protected Project create()

java.util.List getBuildCommands()

Deprecated.

java.lang.String getComment()

Deprecated.

java.util.Set getLinks()

Deprecated.

java.util.List getNatures()

Deprecated.

java.lang.String getProjectName()

Deprecated.

java.util.Set getReferencedProjects()

Deprecated.

void link(java.util.Map args)

Deprecated.

void natures(java.lang.String... natures)

Deprecated.

void referencedProjects(java.lang.String... referencedProjects)

Deprecated.

void setBuildCommands(java.util.List buildCommands)

void setComment(java.lang.String comment)

void setLinks(java.util.Set links)

void setNatures(java.util.List natures)

void setProjectName(java.lang.String projectName)

void setReferencedProjects(java.util.Set referencedProjects)

 
Methods inherited from class XmlGeneratorTask
configure, create, getXmlTransformer, withXml, withXml
 
Methods inherited from class GeneratorTask
beforeConfigured, beforeConfigured, getInputFile, getOutputFile, setInputFile, setOutputFile, whenConfigured, whenConfigured
 
Methods inherited from class org.gradle.api.internal.ConventionTask
org.gradle.api.internal.ConventionTask#conventionMapping(java.lang.String, org.gradle.api.tasks.ConventionValue), org.gradle.api.internal.ConventionTask#getConventionMapping(), org.gradle.api.internal.ConventionTask#setConventionMapping(org.gradle.api.internal.ConventionMapping), org.gradle.api.internal.ConventionTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.internal.ConventionTask#toString(), org.gradle.api.internal.ConventionTask#compareTo(org.gradle.api.Task), org.gradle.api.internal.ConventionTask#compareTo(java.lang.Object), org.gradle.api.internal.ConventionTask#getName(), org.gradle.api.internal.ConventionTask#getActions(), org.gradle.api.internal.ConventionTask#setName(java.lang.String), org.gradle.api.internal.ConventionTask#getState(), org.gradle.api.internal.ConventionTask#getPath(), org.gradle.api.internal.ConventionTask#getLogger(), org.gradle.api.internal.ConventionTask#leftShift(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#execute(), org.gradle.api.internal.ConventionTask#configure(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#configure(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#isEnabled(), org.gradle.api.internal.ConventionTask#getDescription(), org.gradle.api.internal.ConventionTask#captureStandardOutput(org.gradle.api.logging.LogLevel), org.gradle.api.internal.ConventionTask#disableStandardOutputCapture(), org.gradle.api.internal.ConventionTask#property(java.lang.String), org.gradle.api.internal.ConventionTask#setEnabled(boolean), org.gradle.api.internal.ConventionTask#getOutputs(), org.gradle.api.internal.ConventionTask#getOutputs(), org.gradle.api.internal.ConventionTask#getProject(), org.gradle.api.internal.ConventionTask#setActions(java.util.List), org.gradle.api.internal.ConventionTask#getTaskDependencies(), org.gradle.api.internal.ConventionTask#getTaskDependencies(), org.gradle.api.internal.ConventionTask#getDependsOn(), org.gradle.api.internal.ConventionTask#setDependsOn(java.lang.Iterable), org.gradle.api.internal.ConventionTask#dependsOn([Ljava.lang.Object;), org.gradle.api.internal.ConventionTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.ConventionTask#onlyIf(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.ConventionTask#setDidWork(boolean), org.gradle.api.internal.ConventionTask#getDidWork(), org.gradle.api.internal.ConventionTask#doFirst(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#doFirst(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#doLast(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#doLast(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#deleteAllActions(), org.gradle.api.internal.ConventionTask#getEnabled(), org.gradle.api.internal.ConventionTask#getAnt(), org.gradle.api.internal.ConventionTask#getLogging(), org.gradle.api.internal.ConventionTask#hasProperty(java.lang.String), org.gradle.api.internal.ConventionTask#getConvention(), org.gradle.api.internal.ConventionTask#setDescription(java.lang.String), org.gradle.api.internal.ConventionTask#getGroup(), org.gradle.api.internal.ConventionTask#setGroup(java.lang.String), org.gradle.api.internal.ConventionTask#dependsOnTaskDidWork(), org.gradle.api.internal.ConventionTask#getInputs(), org.gradle.api.internal.ConventionTask#getTemporaryDir(), org.gradle.api.internal.ConventionTask#getExtensions(), org.gradle.api.internal.ConventionTask#getAsDynamicObject(), org.gradle.api.internal.ConventionTask#getAdditionalProperties(), org.gradle.api.internal.ConventionTask#getStandardOutputCapture(), org.gradle.api.internal.ConventionTask#executeWithoutThrowingTaskFailure(), org.gradle.api.internal.ConventionTask#setProject(org.gradle.api.Project), org.gradle.api.internal.ConventionTask#getDynamicObjectHelper(), org.gradle.api.internal.ConventionTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.internal.ConventionTask#getValidators(), org.gradle.api.internal.ConventionTask#getExecuter(), org.gradle.api.internal.ConventionTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.internal.ConventionTask#getOnlyIf(), org.gradle.api.internal.ConventionTask#getTemporaryDirFactory(), org.gradle.api.internal.ConventionTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.util.concurrent.Callable), org.gradle.api.internal.ConventionTask#wait(), org.gradle.api.internal.ConventionTask#wait(long), org.gradle.api.internal.ConventionTask#wait(long, int), org.gradle.api.internal.ConventionTask#equals(java.lang.Object), org.gradle.api.internal.ConventionTask#hashCode(), org.gradle.api.internal.ConventionTask#getClass(), org.gradle.api.internal.ConventionTask#notify(), org.gradle.api.internal.ConventionTask#notifyAll()
 

Property Detail

projectModel

EclipseProject projectModel
model for eclipse project (.project) generation


 
Constructor Detail

GenerateEclipseProject

GenerateEclipseProject()


 
Method Detail

buildCommand

@Deprecated
void buildCommand(java.util.Map args, java.lang.String buildCommand)
Deprecated. Please use #eclipse.project.buildCommand. See examples in EclipseProject.

Adds a build command with arguments to the eclipse project.

Parameters:
args - A map with arguments, where the key is the name of the argument and the value the value.
buildCommand - The name of the build command.
See Also:
buildCommand(String)


buildCommand

@Deprecated
void buildCommand(java.lang.String buildCommand)
Deprecated. Please use #eclipse.project.buildCommand. See examples in EclipseProject.

Adds a build command to the eclipse project.

Parameters:
buildCommand - The name of the build command
See Also:
buildCommand(Map, String)


configure

@Override
protected void configure(Project project)


create

@Override
protected Project create()


getBuildCommands

@Deprecated
java.util.List getBuildCommands()
Deprecated. Please use #eclipse.project.buildCommands. See examples in EclipseProject.

The build commands to be added to this Eclipse project.


getComment

@Deprecated
java.lang.String getComment()
Deprecated. Please use #eclipse.project.comment. See examples in EclipseProject.

A comment used for the eclipse project


getLinks

@Deprecated
java.util.Set getLinks()
Deprecated. Please use #eclipse.project.linkedResources. See examples in EclipseProject.

The linked resources to be added to this Eclipse project.


getNatures

@Deprecated
java.util.List getNatures()
Deprecated. Please use #eclipse.project.natures. See examples in EclipseProject.

The natures to be added to this Eclipse project.


getProjectName

@Deprecated
java.lang.String getProjectName()
Deprecated. Please use #eclipse.project.name. See examples in EclipseProject.

Configures eclipse project name. It is optional because the task should configure it correctly for you. By default it will try to use the project.name or prefix it with a part of a project.path to make sure the moduleName is unique in the scope of a multi-module build. The 'uniqeness' of a module name is required for correct import into Eclipse and the task will make sure the name is unique.

The logic that makes sure project names are uniqe is available since 1.0-milestone-2

In case you need to override the default projectName this is the way to go:

 apply plugin: 'eclipse'

 eclipseProject {
   projectName = 'some-important-project'
 }
 


getReferencedProjects

@Deprecated
java.util.Set getReferencedProjects()
Deprecated. Please use #eclipse.project.referencedProjects. See examples in EclipseProject.

The referenced projects of this Eclipse project.


link

@Deprecated
void link(java.util.Map args)
Deprecated. Please use #eclipse.project.linkedResource. See examples in EclipseProject.

Adds a link to the eclipse project.

Parameters:
args - A maps with the args for the link. Legal keys for the map are name, type, location and locationUri.


natures

@Deprecated
void natures(java.lang.String... natures)
Deprecated. Please use #eclipse.project.natures. See examples in EclipseProject.

Adds natures entries to the eclipse project.

Parameters:
natures - the nature names


referencedProjects

@Deprecated
void referencedProjects(java.lang.String... referencedProjects)
Deprecated. Please use #eclipse.project.referencedProjects. See examples in EclipseProject.

Adds project references to the eclipse project.

Parameters:
referencedProjects - The name of the project references.


setBuildCommands

@Deprecated
void setBuildCommands(java.util.List buildCommands)


setComment

@Deprecated
void setComment(java.lang.String comment)


setLinks

@Deprecated
void setLinks(java.util.Set links)


setNatures

@Deprecated
void setNatures(java.util.List natures)


setProjectName

@Deprecated
void setProjectName(java.lang.String projectName)


setReferencedProjects

@Deprecated
void setReferencedProjects(java.util.Set referencedProjects)


 

Groovy Documentation