第38章 Eclipse プラグイン

To completely rewrite existing Eclipse files, execute a clean task together with its corresponding generation task, like “gradle cleanEclipse eclipse” (in that order). If you want to make this the default behavior, add “tasks.eclipse.dependsOn(cleanEclipse)” to your build script. This makes it unnecessary to execute the clean task explicitly.

既存の Eclipse ファイルを完全に上書きしたい場合は、対応する生成タスクと一緒に clean タスクも実行します。 例えば gradle cleanEclipse eclipse のように... (もちろん この順番で...) もし、この動きをデフォルトにしたい場合は、ビルドスクリプトに eclipse.dependsOn(cleanEclipse) を追加します。 そうすれば 明示的に clean タスクを実行する必要はありません。

This strategy can also be used for individual files that the plugin would generate. For instance, this can be done for the “.classpath” file with “gradle cleanEclipseClasspath eclipseClasspath”.

Complete overwrite works equally well for individual files, for example by executing gradle cleanEclipseClasspath eclipseClasspath.

個々のファイルについても同じように完全に上書きすることができます。例えば、 gradle cleanEclipseClasspath eclipseClasspath のように...

A complete overwrite causes all existing content to be discarded, thereby losing any changes made directly in the IDE. Alternatively, the beforeMerged hook makes it possible to overwrite just certain parts of the existing content. The following example removes all existing dependencies from the Classpath domain object: 完全に上書きしてしまうと 既存の内容を全て破棄してしまいます。 それにより IDE で直接変更した内容が消されてしまいます。beforeMerged フックを使えば 既存の内容の一部だけを上書きすることができます。 次の例は 存在する全ての依存関係を classpath ドメインオブジェクトから削除します。

eclipse.classpath.file {
    beforeMerged { classpath ->
        classpath.entries.removeAll { entry -> entry.kind == 'lib' || entry.kind == 'var' }
    }
}

The resulting .classpath file will only contain Gradle-generated dependency entries, but not any other dependency entries that may have been present in the original file. (In the case of dependency entries, this is also the default behavior.) Other sections of the .classpath file will be either left as-is or merged. The same could be done for the natures in the .project file: この例で生成された .classpath ファイルには Gradleによって生成された依存関係のエントリしか含みません。 元のファイルにあった他の依存関係のエントリは全く含みません。(依存関係のエントリの場合はこれがデフォルトの振る舞いです。) .classpathファイルの他のセクションは そのまま残るかマージされるでしょう。 .project ファイルの ネーチャーでも同様です。

eclipse.project.file.beforeMerged { project ->
    project.natures.clear()
}

The whenMerged hook allows to manipulate the fully populated domain objects. Often this is the preferred way to customize Eclipse files. Here is how you would export all the dependencies of an Eclipse project:

eclipse.classpath.file {
    whenMerged { classpath ->
        classpath.entries.findAll { entry -> entry.kind == 'lib' }*.exported = false
    }
}

whenMergedフックは完全にデータが設定されたドメインオブジェクトを操作することができます。 これは Eclipse のファイルをカスタマイズするのにはよい方法です。 以下は Eclipse プロジェクトの全ての依存関係をエクスポートする方法です:

eclipse.classpath.file {
    whenMerged { classpath ->
        classpath.entries.findAll { entry -> entry.kind == 'lib' }*.exported = false
    }
}

The withXmlhook allows to manipulate the in-memory XML representation just before the file gets written to disk. Although Groovy's XML support makes up for a lot, this approach is less convenient than manipulating the domain objects. In return, you get total control over the generated file, including sections not modeled by the domain objects.

apply plugin: 'eclipse-wtp'

eclipse.wtp.facet.file.withXml { provider ->
    provider.asNode().fixed.find { it.@facet == 'jst.java' }.@facet = 'jst2.java'
}

withXmlフックはディスクに書き出される直前のメモリ内の XML 表現を操作することができます。 ただ、Groovy の XML サポートがいろいろと補ってくれたとしても、このアプローチはドメインオブジェクトを操作するほど便利ではありません。 その代わりに、生成されたファイルを通して全ての操作が可能です。もちろん、ドメインオブジェクトにモデル化されなかったセクションも含みます。

apply plugin: 'eclipse-wtp'

eclipse.wtp.facet.file.withXml { provider ->
    provider.asNode().fixed.find { it.@facet == 'jst.java' }.@facet = 'jst2.java'
}