Support free tutorials



vogella training Training Books

Eclipse Target Platform - Tutorial

Lars Vogel

Version 7.4

18.08.2014

Eclipse Target Platform

Via a target platform you define which set of plug-ins and what version of Eclipse you develop against. This tutorial describes how to setup your target platform for Eclipse Plug-in and RCP development.


Table of Contents

1. Eclipse target platform
1.1. Defining available plug-ins for development
1.2. Target platform definition
1.3. Using an explicit target definition file
2. Defining a target platform
3. Exercise: Setting up a target platform
3.1. Creating a target definition file
3.2. Activate your target platform for development
3.3. Validate that target platform is active
3.4. Solving potential issues for development
4. Learn more about Eclipse 4 RCP development
5. About this website
6. Links and Literature
6.1. Target platform resources

Get the book Eclipse RCP book

1. Eclipse target platform

1.1. Defining available plug-ins for development

The set of plug-ins which you can use for your development or your build process to resolve the project dependencies is defined by the plug-ins in your workspace in addition with the plug-ins defined by your target platform.

For example your plug-ins use classes from the SWT and JFace plug-ins.

By default the plug-in installed in your Eclipse IDE installation are used as target platform.

1.2. Target platform definition

You can specify your target platform with a target definition file. With such a file you define the available plug-ins and features.

Tip

A target platform can be defined based on software sites (p2 update sites) or other means. As the new build system like Maven Tycho support only p2 update sites, it is recommended to use only these.

A target definition file is typically shared between the developers to ensure that everyone is using the same basis for development.

1.3. Using an explicit target definition file

It is good practice to develop and build against a specific target definition. This way it can be ensured that dependencies and their versions doesn’t change during the development. Via an explicit target definition it can also be ensured that all developers in a team are using the same dependencies and versions, rather than being dependent on the versions installed in the IDE of every developer.

Developing against your IDE installation has the following disadvantages:

  • it makes you dependent on your version of the Eclipse IDE

  • it can lead to problems if developers are using different versions of Eclipse because the API might be different

  • it makes it difficult to upgrade the set of available plug-ins for every developer at the same time

  • it also requires that you install every plug-in required for your product either in your workspace or in your Eclipse IDE

  • it can happen that you might unintentionally add plug-ins from the Eclipse IDE to your development

2. Defining a target platform

A target definition file can be created via FileNewOther...Plug-in DevelopmentTarget Definition.

Define File name for Target Definition

You can add new locations via the Add... button in the Locations section. To add an Eclipse p2 update site, select Software Site and specify the URL.

Once you have a target definition file, you can set it as the target platform in your Eclipse IDE. This can be done via the Set as Target Platform link in the Target definition editor as depicted in the following screenshot.

Setting the new defined target definition as target for the development

Tip

Wait until the target platform is completely resolved before setting it as target platform.

You can switch the target platform in the Eclipse Preferences. Select WindowPreferencesPlug-in DevelopmentTarget Platform.

Setting the target definition via the Eclipse Preferences

The most effective way of defining your target platform is to use p2 update sites. These are of the same type as the update sites that you used to install a new set of plug-ins. If the content in the update sites defined by your target platform changes, your local set of plug-ins can be updated.

It is also possible to define your target platform based on plug-ins in your file system, but this is not recommended as certain build system like Maven/Tycho do not support file based target definition files.

3. Exercise: Setting up a target platform

3.1. Creating a target definition file

Create a new project called com.vogella.build.targetdefinition of type General via FileNewOther...GeneralProject.

Create a project for your target definition file

Create a new target definition file via the FileNewOther...Plug-in DevelopmentTarget Definition menu path. Use the com.vogella.build.targetdefinition.target as file name.

Define target definition file

Press the Add... button.

Add content to target definition file

Select Software site in the following dialog.

Add content to target definition file

Press the Next button and enter the http://download.eclipse.org/eclipse/updates/4.4 URL in the Work with selection box. This is the update site for the Eclipse 4.4 (Luna) release.

Remove the Group by Category flag and add the following components:

Table 1. Target components

Component Description
Eclipse RCP SDK Components for RCP
Eclipse Platform Launcher Executables The native launchers for the platform, ensure to select the non "black and white" entry if this exists. This entry is empty.
Eclipse JDT Plug-in Developer Resources Required for JUnit
Equinox p2, Provisioning for IDEs Update functionality


The result should look similar to the following screenshot. Please note that your version numbers might be different.

Note

If you use SWTBot for unit tests, add SWTBot for SWT Testing features from http://download.eclipse.org/technology/swtbot/releases/latest/ to your target platform.

3.2. Activate your target platform for development

Afterwards press the Set as Target Platform to activate it. See Section 3.4, “Solving potential issues for development” in case you have problems with your new target platform.

3.3. Validate that target platform is active

Try to add the org.eclipse.pde.ui plug-in as dependency to one of your plug-ins. This should not be possible.

3.4. Solving potential issues for development

Your target platform depends on external update sites and their packaging of plug-ins. Theses update sites might change over time, so you should be able to revert your target platform settings in case you face issues.

You can switch back to your Eclipse IDE as target platform via WindowPreferencesPlug-in DevelopmentTarget Platform.

4. Learn more about Eclipse 4 RCP development

I hope you enjoyed this tutorial. You find this tutorial and much more information also in the Eclipse 4 RCP book from this author.

5. About this website

6. Links and Literature

6.1. Target platform resources

Target definition wiki