org.eclipse.ercp.eworkbench
Class eWorkbench

java.lang.Object
  extended by org.eclipse.ercp.eworkbench.eWorkbench
All Implemented Interfaces:
IExecutableExtension, IPlatformRunnable

public class eWorkbench
extends java.lang.Object
implements IPlatformRunnable, IExecutableExtension

The "main program" for eRCP


Field Summary
 
Fields inherited from interface org.eclipse.core.runtime.IPlatformRunnable
EXIT_OK, EXIT_RESTART
 
Constructor Summary
eWorkbench()
          Creates a new IDE application.
 
Method Summary
protected  Display createDisplay()
          Creates the display used by the application.
 java.lang.Object run(java.lang.Object args)
          Runs this runnable with the given args and returns a result.
 void setInitializationData(IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
          This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

eWorkbench

public eWorkbench()
Creates a new IDE application.

Method Detail

run

public java.lang.Object run(java.lang.Object args)
                     throws java.lang.Exception
Description copied from interface: IPlatformRunnable
Runs this runnable with the given args and returns a result. The content of the args is unchecked and should conform to the expectations of the runnable being invoked. Typically this is a String array. Applications can return any object they like. If an Integer is returned it is treated as the program exit code if Eclipse is exiting.

Specified by:
run in interface IPlatformRunnable
Parameters:
args - the argument(s) to pass to the application
Returns:
the return value of the application
Throws:
java.lang.Exception - if there is a problem running this runnable.
See Also:
IPlatformRunnable.EXIT_OK, IPlatformRunnable.EXIT_RESTART, IPlatformRunnable.EXIT_RELAUNCH

createDisplay

protected Display createDisplay()
Creates the display used by the application.

Returns:
the display used by the application

setInitializationData

public void setInitializationData(IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)
                           throws CoreException
Description copied from interface: IExecutableExtension
This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information. Most executable extensions only make use of the first two call arguments.

Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example

     <action run="com.example.BaseAction"/>
 
In the above example, this method would be called with a reference to the <action> element (first argument), and "run" as the name of the attribute that defined this executable extension (second argument).

The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.

There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:

(1) by specifying adapter data as part of the implementation class attribute value. The Java class name can be followed by a ":" separator, followed by any adapter data in string form. For example, if the extension point specifies an attribute "run" to contain the name of the extension implementation, an adapter can be configured as

     <action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
 

(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become

     <action>
         <run class="com.xyz.ExternalAdapter">
             <parameter name="exec" value="./cmds/util.exe"/>
             <parameter name="opt"  value="3"/>
         </run>
     </action>
 

Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.

In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:

Specified by:
setInitializationData in interface IExecutableExtension
Parameters:
config - the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration properties
propertyName - the name of an attribute of the configuration element used on the createExecutableExtension(String) call. This argument can be used in the cases where a single configuration element is used to define multiple executable extensions.
data - adapter data in the form of a String, a Hashtable, or null.
Throws:
CoreException - if error(s) detected during initialization processing
See Also:
IConfigurationElement.createExecutableExtension(String)