org.gradle.plugins.ide.eclipse.model
[Groovy] Class EclipseProject

java.lang.Object
  org.gradle.plugins.ide.eclipse.model.EclipseProject

class EclipseProject

Enables fine-tuning project details (.project file) of the Eclipse plugin

Example of use with a blend of all possible properties. Bear in mind that usually you don't have configure eclipse project directly because Gradle configures it for free!

 apply plugin: 'java'
 apply plugin: 'eclipse'

 eclipse {
   project {
     //if you don't like the name Gradle has chosen
     name = 'someBetterName'

     //if you want to specify the Eclipse project's comment
     comment = 'Very interesting top secret project'

     //if you want to append some extra referenced projects in a declarative fashion:
     referencedProjects 'someProject', 'someOtherProject'
     //if you want to assign referenced projects
     referencedProjects = ['someProject'] as Set

     //if you want to append some extra natures in a declarative fashion:
     natures 'some.extra.eclipse.nature', 'some.another.interesting.nature'
     //if you want to assign natures in a groovy fashion:
     natures = ['some.extra.eclipse.nature', 'some.another.interesting.nature']

     //if you want to append some extra build command:
     buildCommand 'buildThisLovelyProject'
     //if you want to append a build command with parameters:
     buildCommand 'buildItWithTheArguments', argumentOne: "I'm first", argumentTwo: "I'm second"

     //if you want to create an extra link in the eclipse project,
     //by location uri:
     linkedResource name: 'someLinkByLocationUri', type: 'someLinkType', locationUri: 'file://someUri'
     //by location:
     linkedResource name: 'someLinkByLocation', type: 'someLinkType', location: '/some/location'
   }
 }
 

beforeMerged and whenMerged closures receive Project object

Examples of advanced configuration:

 apply plugin: 'java'
 apply plugin: 'eclipse'

 eclipse {
   project {

     file {
       //if you want to mess with the resulting xml in whatever way you fancy
       withXml {
         def node = it.asNode()
         node.appendNode('xml', 'is what I love')
       }

       //closure executed after .project content is loaded from existing file
       //but before gradle build information is merged
       beforeMerged { project ->
         //if you want skip merging natures... (a very abstract example)
         project.natures.clear()
       }

       //closure executed after .project content is loaded from existing file
       //and after gradle build information is merged
       whenMerged { project ->
         //you can tinker with the Project here
       }
     }
   }
 }
 

Authors:

Szczepan Faber, created at: 4/13/11

buildCommands

List buildCommands

The build commands to be added to this Eclipse project.

For example see docs for EclipseProject

comment

String comment

A comment used for the eclipse project. By default it will be configured to project.description

For example see docs for EclipseProject

file

final XmlFileContentMerger file

See file(Closure)

linkedResources

Set linkedResources

The linked resources to be added to this Eclipse project.

For example see docs for EclipseProject

name

String name

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 'uniqueness' 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 unique is available since 1.0-milestone-2

If your project has problems with unique names it is recommended to always run gradle eclipse from the root, e.g. for all subprojects, including generation of .classpath. If you run the generation of the eclipse project only for a single subproject then you may have different results because the unique names are calculated based on eclipse projects that are involved in the specific build run.

If you update the project names then make sure you run gradle eclipse from the root, e.g. for all subprojects. The reason is that there may be subprojects that depend on the subproject with amended eclipse project name. So you want them to be generated as well because the project dependencies in .classpath need to refer to the amended project name. Basically, for non-trivial projects it is recommended to always run gradle eclipse from the root.

For example see docs for EclipseProject

natures

List natures

The natures to be added to this Eclipse project.

For example see docs for EclipseProject

referencedProjects

Set referencedProjects

The referenced projects of this Eclipse project (*not*: java build path project references).

Referencing projects does not mean adding a build path dependencies between them! If you need to configure a build path dependency use Gradle's dependencies section or eclipse.classpath.whenMerged { classpath -> ... to manipulate the classpath entries

For example see docs for EclipseProject

EclipseProject

EclipseProject(XmlFileContentMerger file)

*

buildCommand

void buildCommand(Map args, String buildCommand)

Adds a build command with arguments to the eclipse project.

For example see docs for EclipseProject

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

void buildCommand(String buildCommand)

Adds a build command to the eclipse project.

For example see docs for EclipseProject

Parameters:

buildCommand - The name of the build command

See Also:

buildCommand(Map, String)

file

void file(Closure closure)

Enables advanced configuration like tinkering with the output xml or affecting the way existing .project content is merged with gradle build information

The object passed to whenMerged{} and beforeMerged{} closures is of type Project

For example see docs for EclipseProject

linkedResource

void linkedResource(Map args)

Adds a resource link (aka 'source link') to the eclipse project.

For example see docs for EclipseProject

Parameters:

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

mergeXmlProject

void mergeXmlProject(Project xmlProject)

natures

void natures(String... natures)

Appends natures entries to the eclipse project.

For example see docs for EclipseProject

Parameters:

natures - the nature names

referencedProjects

void referencedProjects(String... referencedProjects)

The referenced projects of this Eclipse project (*not*: java build path project references).

Referencing projects does not mean adding a build path dependencies between them! If you need to configure a build path dependency use Gradle's dependencies section or eclipse.classpath.whenMerged { classpath -> ... to manipulate the classpath entries

Parameters:

referencedProjects - The name of the project references.

Gradle API 1.0