GenerateEclipseClasspath

API Documentation:GenerateEclipseClasspath

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

At this moment nearly all configuration is done via EclipseClasspath.

Properties

PropertyDescription
containers

Deprecated. Please use #eclipse.classpath.containers. See examples in EclipseClasspath.

defaultOutputDir

Deprecated. Please use #eclipse.classpath.defaultOutputDir. See examples in EclipseClasspath.

downloadJavadoc

Deprecated. Please use #eclipse.classpath.downloadJavadoc. See examples in EclipseClasspath.

downloadSources

Deprecated. Please use #eclipse.classpath.downloadSources. See examples in EclipseClasspath.

inputFile

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.

minusConfigurations

Deprecated. Please use #eclipse.classpath.minusConfigurations. See examples in EclipseClasspath.

outputFile

The output file to write the final configuration to.

plusConfigurations

Deprecated. Please use #eclipse.classpath.plusConfigurations. See examples in EclipseClasspath.

sourceSets

Deprecated. Please use #eclipse.classpath.sourceSets. See examples in EclipseClasspath.

variables

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseClasspath.

Property details

Set<String> containers

Deprecated. Please use #eclipse.classpath.containers. See examples in EclipseClasspath.

Containers to be added to the classpath

Default with eclipse and java plugins:
[JRE container]

File defaultOutputDir

Deprecated. Please use #eclipse.classpath.defaultOutputDir. See examples in EclipseClasspath.

The default output directory for eclipse generated files, eg classes.

Default with eclipse and java plugins:
${project.projectDir}/bin

boolean downloadJavadoc

Deprecated. Please use #eclipse.classpath.downloadJavadoc. See examples in EclipseClasspath.

Whether to download and add javadocs associated with the dependency jars. Defaults to false.

Default with eclipse and java plugins:
false

boolean downloadSources

Deprecated. Please use #eclipse.classpath.downloadSources. See examples in EclipseClasspath.

Whether to download and add sources associated with the dependency jars. Defaults to true.

Default with eclipse and java plugins:
true

File inputFile

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.

Collection<Configuration> minusConfigurations

Deprecated. Please use #eclipse.classpath.minusConfigurations. See examples in EclipseClasspath.

The configurations which files are to be excluded from the classpath entries.

Default with eclipse and java plugins:
[]

File outputFile

The output file to write the final configuration to.

Default with eclipse and java plugins:
${project.projectDir}/.classpath

Collection<Configuration> plusConfigurations

Deprecated. Please use #eclipse.classpath.plusConfigurations. See examples in EclipseClasspath.

The configurations which files are to be transformed into classpath entries.

Default with eclipse and java plugins:
project.configurations.testRuntime

Iterable<SourceSet> sourceSets

Deprecated. Please use #eclipse.classpath.sourceSets. See examples in EclipseClasspath.

The source sets to be added to the classpath.

Default with eclipse and java plugins:
project.sourceSets

Map<String, File> variables

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseClasspath.

Adds path variables to be used for replacing absolute paths in classpath entries.

Default with eclipse and java plugins:
[:]

Script blocks

No script blocks

Methods

MethodDescription
beforeConfigured(closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

beforeConfigured(action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

containers(containers)

Deprecated. Please use #eclipse.classpath.containers. See examples in EclipseClasspath.

variables(variables)

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseClasspath.

whenConfigured(closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

whenConfigured(action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

withXml(closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

withXml(action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Method details

void beforeConfigured(Closure closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds a closure to be called before the domain object is configured by this task. The domain object is passed as a parameter to the closure.

The closure is executed after the domain object has been loaded from the input file. Using this method allows you to change the domain object in some way before the task configures it.

void beforeConfigured(Action<? super T> action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds an action to be called before the domain object is configured by this task. The domain object is passed as a parameter to the action.

The action is executed after the domain object has been loaded from the input file. Using this method allows you to change the domain object in some way before the task configures it.

void containers(String... containers)

Deprecated. Please use #eclipse.classpath.containers. See examples in EclipseClasspath.

Adds containers to the .classpath.

void variables(Map<String, File> variables)

Deprecated. Please use #eclipse.pathVariables. See examples in EclipseClasspath.

Adds variables to be used for replacing absolute paths in classpath entries.

void whenConfigured(Closure closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds a closure to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the closure.

The closure is executed just before the domain object is written to the output file. Using this method allows you to override the configuration applied by this task.

void whenConfigured(Action<? super T> action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds an action to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the action.

The action is executed just before the domain object is written to the output file. Using this method allows you to override the configuration applied by this task.

void withXml(Closure closure)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds a closure to be called when the XML document has been created. The XML is passed to the closure as a parameter in form of a XmlProvider. The closure can modify the XML before it is written to the output file.

void withXml(Action<? super XmlProvider> action)

Deprecated. Moved to the relevant type. Where? For starters, see examples in IdeaProject or EclipseProject.

Adds an action to be called when the XML document has been created. The XML is passed to the action as a parameter in form of a XmlProvider. The action can modify the XML before it is written to the output file.