EclipseModel (Gradle API 7.6.4)

Package org.gradle.plugins.ide.eclipse.model

## Class EclipseModel

- java.lang.Object
- - org.gradle.plugins.ide.eclipse.model.EclipseModel

-     public class EclipseModel
      extends java.lang.Object

  DSL-friendly model of the Eclipse project information. First point of entry for customizing Eclipse project generation.

       plugins {
           id 'java'
           id 'eclipse'
           id 'eclipse-wtp' // for web projects only
       }

       eclipse {
         pathVariables 'GRADLE_HOME': file('/best/software/gradle'), 'TOMCAT_HOME': file('../tomcat')

         project {
           //see docs for EclipseProject
         }

         classpath {
           //see docs for EclipseClasspath
         }

         wtp {
           //see docs for EclipseWtp
         }
       }

  More examples in docs for `EclipseProject`, `EclipseClasspath`, `EclipseWtp`

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `EclipseModel()` |
    `EclipseModel​(Project project)` | Constructor.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | `autoBuildTasks​(java.lang.Object... autoBuildTasks)` | Set tasks to be executed during the Eclipse auto-build.
    `void` | `classpath​(Closure closure)` | Configures eclipse classpath information
    `void` | `classpath​(Action<? super EclipseClasspath> action)` | Configures eclipse classpath information
    `TaskDependency` | `getAutoBuildTasks()` | Returns the tasks to be executed during the Eclipse auto-build.
    `EclipseClasspath` | `getClasspath()` | Configures eclipse classpath information
    `EclipseJdt` | `getJdt()` | Configures eclipse java compatibility information (jdt)
    `protected ObjectFactory` | `getObjectFactory()` | Injects and returns an instance of `ObjectFactory`.
    `EclipseProject` | `getProject()` | Configures eclipse project information
    `TaskDependency` | `getSynchronizationTasks()` | Returns the tasks to be executed before the Eclipse synchronization starts.
    `EclipseWtp` | `getWtp()` | Configures eclipse wtp information
    `void` | `jdt​(Closure closure)` | Configures eclipse java compatibility information (jdt)
    `void` | `jdt​(Action<? super EclipseJdt> action)` | Configures eclipse java compatibility information (jdt)
    `void` | `pathVariables​(java.util.Map<java.lang.String,​java.io.File> pathVariables)` | Adds path variables to be used for replacing absolute paths in classpath entries.
    `void` | `project​(Closure closure)` | Configures eclipse project information
    `void` | `project​(Action<? super EclipseProject> action)` | Configures eclipse project information
    `void` | `setClasspath​(EclipseClasspath classpath)` |
    `void` | `setJdt​(EclipseJdt jdt)` |
    `void` | `setProject​(EclipseProject project)` |
    `void` | `setWtp​(EclipseWtp wtp)` |
    `void` | `synchronizationTasks​(java.lang.Object... synchronizationTasks)` | Set tasks to be executed before the Eclipse synchronization.
    `void` | `wtp​(Closure closure)` | Configures eclipse wtp information
    `void` | `wtp​(Action<? super EclipseWtp> action)` | Configures eclipse wtp information

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### EclipseModel

          public EclipseModel()

    - #### EclipseModel

          public EclipseModel​(Project project)

      Constructor.
      Since:
        5.4

  - ### Method Detail

    - #### getObjectFactory

          @Inject
          protected ObjectFactory getObjectFactory()

      Injects and returns an instance of `ObjectFactory`.
      Since:
        4.9

    - #### getProject

          public EclipseProject getProject()

      Configures eclipse project information

      For examples see docs for `EclipseProject`

    - #### setProject

          public void setProject​(EclipseProject project)

    - #### getClasspath

          public EclipseClasspath getClasspath()

      Configures eclipse classpath information

      For examples see docs for `EclipseClasspath`

    - #### setClasspath

          public void setClasspath​(EclipseClasspath classpath)

    - #### getJdt

          public EclipseJdt getJdt()

      Configures eclipse java compatibility information (jdt)

      For examples see docs for `EclipseProject`

    - #### setJdt

          public void setJdt​(EclipseJdt jdt)

    - #### getWtp

          public EclipseWtp getWtp()

      Configures eclipse wtp information

      For examples see docs for `EclipseWtp`

    - #### setWtp

          public void setWtp​(EclipseWtp wtp)

    - #### project

          public void project​(@DelegatesTo(EclipseProject.class)
                              Closure closure)

      Configures eclipse project information

      For examples see docs for `EclipseProject`

    - #### project

          public void project​(Action<? super EclipseProject> action)

      Configures eclipse project information

      For examples see docs for `EclipseProject`

      Since:
        3.5

    - #### classpath

          public void classpath​(@DelegatesTo(EclipseClasspath.class)
                                Closure closure)

      Configures eclipse classpath information

      For examples see docs for `EclipseClasspath`

    - #### classpath

          public void classpath​(Action<? super EclipseClasspath> action)

      Configures eclipse classpath information

      For examples see docs for `EclipseClasspath`

      Since:
        3.5

    - #### wtp

          public void wtp​(@DelegatesTo(EclipseWtp.class)
                          Closure closure)

      Configures eclipse wtp information

      For examples see docs for `EclipseWtp`

    - #### wtp

          public void wtp​(Action<? super EclipseWtp> action)

      Configures eclipse wtp information

      For examples see docs for `EclipseWtp`

      Since:
        3.5

    - #### jdt

          public void jdt​(@DelegatesTo(EclipseJdt.class)
                          Closure closure)

      Configures eclipse java compatibility information (jdt)

      For examples see docs for `EclipseProject`

    - #### jdt

          public void jdt​(Action<? super EclipseJdt> action)

      Configures eclipse java compatibility information (jdt)

      For examples see docs for `EclipseProject`

      Since:
        3.5

    - #### getSynchronizationTasks

          public TaskDependency getSynchronizationTasks()

      Returns the tasks to be executed before the Eclipse synchronization starts.

      This property doesn't have a direct effect to the Gradle Eclipse plugin's behaviour. It is used, however, by Buildship to execute the configured tasks each time before the user imports the project or before a project synchronization starts.

      Returns:
        the tasks names
      Since:
        5.4

    - #### synchronizationTasks

          public void synchronizationTasks​(java.lang.Object... synchronizationTasks)

      Set tasks to be executed before the Eclipse synchronization.
      Since:
        5.4
      See Also:
        `getSynchronizationTasks()`

    - #### getAutoBuildTasks

          public TaskDependency getAutoBuildTasks()

      Returns the tasks to be executed during the Eclipse auto-build.

      This property doesn't have a direct effect to the Gradle Eclipse plugin's behaviour. It is used, however, by Buildship to execute the configured tasks each time when the Eclipse automatic build is triggered for the project.

      Returns:
        the tasks names
      Since:
        5.4

    - #### autoBuildTasks

          public void autoBuildTasks​(java.lang.Object... autoBuildTasks)

      Set tasks to be executed during the Eclipse auto-build.
      Since:
        5.4
      See Also:
        `getAutoBuildTasks()`

    - #### pathVariables

          public void pathVariables​(java.util.Map<java.lang.String,​java.io.File> pathVariables)

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

      If the beginning of the absolute path of a library or other path-related element matches a value of a variable, a variable entry is used. The matching part of the library path is replaced with the variable name.

      For example see docs for `EclipseModel`

      Parameters:
        `pathVariables` - A map with String->File pairs.