# EclipseClasspath

abstract class EclipseClasspath(source)

The build path settings for the generated Eclipse project. Used by the org.gradle.plugins.ide.eclipse.GenerateEclipseClasspath task to generate an Eclipse .classpath file.

The following example demonstrates the various configuration options. Keep in mind that all properties have sensible defaults; only configure them explicitly if the defaults don't match your needs.

    plugins {
        id 'java'
        id 'eclipse'
    }

    configurations {
      provided
      someBoringConfig
    }

    eclipse {
      //if you want parts of paths in resulting file to be replaced by variables (files):
      pathVariables 'GRADLE_HOME': file('/best/software/gradle'), 'TOMCAT_HOME': file('../tomcat')

      classpath {
        //you can tweak the classpath of the Eclipse project by adding extra configurations:
        plusConfigurations += [ configurations.provided ]

        //you can also remove configurations from the classpath:
        minusConfigurations += [ configurations.someBoringConfig ]

        //if you want to append extra containers:
        containers 'someFriendlyContainer', 'andYetAnotherContainer'

        //customizing the classes output directory:
        defaultOutputDir = file('build-eclipse')

        //default settings for downloading sources and Javadoc:
        downloadSources = true
        downloadJavadoc = false

        //if you want to expose test classes to dependent projects
        containsTestFixtures = true

        //customizing which Eclipse source directories should be marked as test
        testSourceSets = [sourceSets.test]

        //customizing which dependencies should be marked as test on the project's classpath
        testConfigurations = [configurations.testCompileClasspath, configurations.testRuntimeClasspath]
      }
    }

Content copied to clipboard
For tackling edge cases, users can perform advanced configuration on the resulting XML file. It is also possible to affect the way that the Eclipse plugin merges the existing configuration via beforeMerged and whenMerged closures.

The beforeMerged and whenMerged closures receive a Classpath object.

Examples of advanced configuration:

    plugins {
        id 'java'
        id 'eclipse'
    }

    eclipse {
      classpath {
        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 .classpath content is loaded from existing file
          //but before gradle build information is merged
          beforeMerged { classpath ->
            //you can tinker with the Classpath here
          }

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

Content copied to clipboard

#### Since

1.0

## Constructors

EclipseClasspath
Link copied to clipboard
@Inject
constructor(project: Project)

## Properties

classFolders
Link copied to clipboard
open var classFolders: List<File>
containers
Link copied to clipboard
open var containers: Set<String>
defaultOutputDir
Link copied to clipboard
open var defaultOutputDir: File
file
Link copied to clipboard
open var file: XmlFileContentMerger
minusConfigurations
Link copied to clipboard
open var minusConfigurations: Collection<Configuration>
pathVariables
Link copied to clipboard
open var pathVariables: Map<String, File>
plusConfigurations
Link copied to clipboard
open var plusConfigurations: Collection<Configuration>
project
Link copied to clipboard
val project: Project
sourceSets
Link copied to clipboard
open var sourceSets: Iterable<SourceSet>

## Functions

containers
Link copied to clipboard
open fun containers(containers: Array<String>)
Further classpath containers to be added.
file
Link copied to clipboard
open fun file(@DelegatesTo(value = XmlFileContentMerger::class) closure: Closure)
open fun file(action: Action<in XmlFileContentMerger>)
Enables advanced configuration like tinkering with the output XML or affecting the way that the contents of an existing .classpath file is merged with Gradle build information.
getBaseSourceOutputDir
Link copied to clipboard
@Incubating
abstract fun getBaseSourceOutputDir(): DirectoryProperty
The base output directory for source sets.
getContainsTestFixtures
Link copied to clipboard
abstract fun getContainsTestFixtures(): Property<Boolean>
Returns `true` if the classpath contains test fixture classes that should be visible through incoming project dependencies.
getFileReferenceFactory
Link copied to clipboard
open fun getFileReferenceFactory(): FileReferenceFactory
Returns the file reference factory.
getTestConfigurations
Link copied to clipboard
@Incubating
abstract fun getTestConfigurations(): SetProperty<Configuration>
Returns the test configurations.
getTestSourceSets
Link copied to clipboard
@Incubating
abstract fun getTestSourceSets(): SetProperty<SourceSet>
Returns the test source sets.
isDownloadJavadoc
Link copied to clipboard
open fun isDownloadJavadoc(): Boolean
Whether to download and associate Javadoc Jars with the dependency Jars.
isDownloadSources
Link copied to clipboard
open fun isDownloadSources(): Boolean
Whether to download and associate source Jars with the dependency Jars.
isProjectDependenciesOnly
Link copied to clipboard
open fun isProjectDependenciesOnly(): Boolean
Returns whether project dependencies only is set.
mergeXmlClasspath
Link copied to clipboard
open fun mergeXmlClasspath(xmlClasspath: Classpath)
Merge xml classpath.
resolveDependencies
Link copied to clipboard
open fun resolveDependencies(): List<ClasspathEntry>
Calculates, resolves and returns dependency entries of this classpath.
setDownloadJavadoc
Link copied to clipboard
open fun setDownloadJavadoc(downloadJavadoc: Boolean)
Sets the download javadoc.
setDownloadSources
Link copied to clipboard
open fun setDownloadSources(downloadSources: Boolean)
Sets the download sources.
setProjectDependenciesOnly
Link copied to clipboard
open fun setProjectDependenciesOnly(projectDependenciesOnly: Boolean)
Sets the project dependencies only.