Package com.diffplug.gradle.oomph
Class OomphIdeExtension
java.lang.Object
com.diffplug.gradle.oomph.OomphIdeExtension
- All Implemented Interfaces:
P2Declarative
DSL for
OomphIdePlugin.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds all eclipse projects from all gradle projects.voidaddAllProjects(Spec<String> include) Adds all eclipse projects from all gradle projects whose paths meet the given spec.voidAdds the buildSrc folder as an eclipse project.voidaddIncludedProject(String includedBuild, String projectPath) Adds an eclipse project from the given included build.voidaddProject(String projectPath) Adds the eclipse project from the given project path.voidaddProjectFolder(Object folderObj) Adds the given folder as an eclipse project.voidaddSetupAction(SetupAction internalSetupAction) Adds an action which will be run inside our running application.voidaddSetupActionLazy(Action<List<SetupAction>> lazyInternalSetupAction) Eventually adds some actions which will be run inside our running application.voiddescription(String description) Sets the description of the generated IDE.voideclipseIni(Action<EclipseIni> eclipseIni) Sets properties in the `eclipse.ini`.voidFinds projects in the included builds.voidgetP2()Returns the P2 model so that users can add the features they'd like.Returns the underlying project.voidSets the icon image - any size and format is okay, but something square is recommended.voidSets the folder where the ide will be built.voidjdt(Action<ConventionJdt> action) Adds the java development tools, @see ConventionJdt.voidlinkedResource(String linkName, Object linkTarget) Links the given target into the workspace with the given name, see [eclipse manual](https://help.eclipse.org/neon/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Fconcepts%2Fconcepts-13.htm).voidSets the name of the generated IDE.voidp2director(Action<P2Model.DirectorApp> directorModifier) Allows for fine-grained manipulation of the mirroring operation.voidpde(Action<ConventionPde> action) Adds the plugin-development environment, @see ConventionPde.voidperspective(String perspective) Sets the starting perspective (window layout), seePerspectivesfor common perspectives.voidrunP2Using(Action<P2Model.DirectorApp> runUsing) Defaults toP2Model.DirectorApp.runUsingBootstrapper()- this allows you to override that behavior.voidProvisions using the latest available version of the full Eclipse PDE.voidrunP2UsingPDE(String version) Provisions using the given version of the full Eclipse PDE.voidvoidSets the splash screen image - any size and format is okay.voidstyle(Action<ConventionStyle> action) Convenience methods for setting the style, @see ConventionStyle.voidthirdParty(Action<ConventionThirdParty> action) Adds third-party tools, @see ConventionThirdParty.voidworkspaceFile(String destination, Object fileSrc) Sets the given path within the workspace directory to be a copy of the file located at fileSrc.voidSets the given path within the workspace directory to be a property file.voidworkspaceXml(String destination, Action<XmlProvider> xmlSupplier) Modifies the xml that was written in a previous call toworkspaceFile(String, Object)orworkspaceXml(String, Action).Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.diffplug.gradle.p2.P2Declarative
append, artifactRepo, artifactRepo, feature, feature, iu, iu, metadataRepo, metadataRepo, repo, repo, repoEclipse, repoEclipseLatest, slicingOption
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
OomphIdeExtension
- Throws:
IOException
-
-
Method Details
-
silenceEquoIDE
public void silenceEquoIDE() -
getProject
Returns the underlying project. -
getP2
Returns the P2 model so that users can add the features they'd like.- Specified by:
getP2in interfaceP2Declarative
-
p2director
Allows for fine-grained manipulation of the mirroring operation. -
icon
Sets the icon image - any size and format is okay, but something square is recommended. -
splash
Sets the splash screen image - any size and format is okay. -
name
Sets the name of the generated IDE. Defaults to the name of the root project. -
description
Sets the description of the generated IDE. Defaults to name. -
perspective
Sets the starting perspective (window layout), seePerspectivesfor common perspectives. -
eclipseIni
Sets properties in the `eclipse.ini`. -
ideDir
Sets the folder where the ide will be built. -
addAllProjects
public void addAllProjects()Adds all eclipse projects from all gradle projects. -
addAllProjects
Adds all eclipse projects from all gradle projects whose paths meet the given spec. -
findProjectsInIncludedBuilds
- See Also:
-
findProjectsInIncludedBuilds
public void findProjectsInIncludedBuilds()Finds projects in the included builds. You have to run `gradlew eclipse` before running `gradle ide` for this to work, because it relies on pre-existing `.project` files to determine the paths to subprojects. Supports root projects and subprojects, but not subsubprojects. -
addIncludedProject
Adds an eclipse project from the given included build. -
addProject
Adds the eclipse project from the given project path. -
addProjectFolder
Adds the given folder as an eclipse project. -
addBuildSrc
public void addBuildSrc()Adds the buildSrc folder as an eclipse project. It's recommended that you add this snippet to your buildSrc, to ensure that your eclipse project stays up-to-date. ```gradle apply plugin: 'eclipse' build.dependsOn(tasks.getByName('eclipse')) ``` -
workspaceFile
Sets the given path within the workspace directory to be a copy of the file located at fileSrc. -
workspaceProp
Sets the given path within the workspace directory to be a property file. If a property file was already written by a previous call toworkspaceFile(String, Object)orworkspaceProp(String, Action), then it can be modified by this action. -
workspaceXml
Modifies the xml that was written in a previous call toworkspaceFile(String, Object)orworkspaceXml(String, Action). However, -
addSetupAction
Adds an action which will be run inside our running application. -
addSetupActionLazy
Eventually adds some actions which will be run inside our running application. -
linkedResource
Links the given target into the workspace with the given name, see [eclipse manual](https://help.eclipse.org/neon/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Fconcepts%2Fconcepts-13.htm). -
runP2Using
Defaults toP2Model.DirectorApp.runUsingBootstrapper()- this allows you to override that behavior. -
runP2UsingPDE
Provisions using the given version of the full Eclipse PDE. -
runP2UsingPDE
public void runP2UsingPDE()Provisions using the latest available version of the full Eclipse PDE. -
style
Convenience methods for setting the style, @see ConventionStyle. -
jdt
Adds the java development tools, @see ConventionJdt. -
pde
Adds the plugin-development environment, @see ConventionPde. -
thirdParty
Adds third-party tools, @see ConventionThirdParty.
-