Difference between revisions of "Eclipse4/API/DI"

From Eclipsepedia

< Eclipse4‎ | API
Jump to: navigation, search
Line 15: Line 15:
 
In order for DI to work there must be some container from which injectable values can be retrieved. In e4 this is the IEclipseContext. In reality these contexts are defined in a tree and the values are retrieved using a lookup strategy (What is it&nbsp;?).  
 
In order for DI to work there must be some container from which injectable values can be retrieved. In e4 this is the IEclipseContext. In reality these contexts are defined in a tree and the values are retrieved using a lookup strategy (What is it&nbsp;?).  
  
The package '''org.eclipse.e4.core.contexts''' provides the API to make, inject or uninject or to invoke specifically annotated methods on an Object.
+
The package '''org.eclipse.e4.core.contexts''' provides the API to make, inject or uninject or to invoke specifically annotated methods on an Object.  
 
+
  
 +
<br>
  
 
{| cellspacing="1" cellpadding="1" border="1" style="width: 726px; height: 257px;"
 
{| cellspacing="1" cellpadding="1" border="1" style="width: 726px; height: 257px;"
 
|-
 
|-
| Active
+
| Active  
| This defines an injection annotation that we don'd appear to use and should be deleted
+
| This defines an injection annotation that we don'd appear to use and ''<u>'''should be deleted'''</u>''<u></u>
 
|-
 
|-
| ContextFunction
+
| ContextFunction  
 
| Defines an abstract class with a single abstract method 'compute' that is called whenever the value is retrieved from an IEclipseContext.
 
| Defines an abstract class with a single abstract method 'compute' that is called whenever the value is retrieved from an IEclipseContext.
 
|-
 
|-
| ContextInjectionFactory
+
| ContextInjectionFactory  
 
| &nbsp;Defines the 'inject', 'make' and 'uninject' methods used to manipulate objects through injection. It also contains a 'setDefault' method that should not be API.
 
| &nbsp;Defines the 'inject', 'make' and 'uninject' methods used to manipulate objects through injection. It also contains a 'setDefault' method that should not be API.
 
|-
 
|-
| IContextFunction
+
| IContextFunction  
| An interface containing a single method 'compute'. ContextFuncton implements this interface but since we expect that clients will be implementing instances of this we should likely remove (deprecate?) this interface in favor of supplying the base class.
+
| An interface containing a single method 'compute'. ContextFuncton implements this interface but since we expect that clients will be implementing instances of this '''''<u>we should likely remove (deprecate?) this interface in favor of supplying the base class</u>''.
 
|-
 
|-
| IEclipseContext
+
| IEclipseContext  
| The interface through which context information is accessed. There are far many methods here...are they all really needed ?
+
| The interface through which context information is accessed. There are far many methods here...are they all really needed&nbsp;?
 
|-
 
|-
| RunAndTrack
+
| RunAndTrack  
 
| An abstract class containing a single abstract mehtod 'changed' and a utility method 'runExternalCode' (should this be final?)
 
| An abstract class containing a single abstract mehtod 'changed' and a utility method 'runExternalCode' (should this be final?)
 
|-
 
|-

Revision as of 15:44, 4 March 2013

Dependency Injection ("DI") and the IEclipseContext

DI (aka 'Inversion of Concerns") is a recent development in development. It's based on teh premise that it's better for a component to describe what it needs and having those requirements met through the use of an appropriate 'context' Rather than requiring the component to rely on external frameworks through which it can satisfy its own requirements.

In order for the component to expose its needs it uses a set of java annotations, some generic (@Inject, @PostConstruct...) as well as domain (e4) specific (@Focus, @CanExecute...).

In order to be useful there are a number of things that must be possible:

  • Create a new instance of a class gicen the class spec and a context
  • Inject an existing instance with the values in a context
  • Find and execute specifically annotated methods within an existing instance

The Eclipse Context

In order for DI to work there must be some container from which injectable values can be retrieved. In e4 this is the IEclipseContext. In reality these contexts are defined in a tree and the values are retrieved using a lookup strategy (What is it ?).

The package org.eclipse.e4.core.contexts provides the API to make, inject or uninject or to invoke specifically annotated methods on an Object.


Active This defines an injection annotation that we don'd appear to use and should be deleted
ContextFunction Defines an abstract class with a single abstract method 'compute' that is called whenever the value is retrieved from an IEclipseContext.
ContextInjectionFactory  Defines the 'inject', 'make' and 'uninject' methods used to manipulate objects through injection. It also contains a 'setDefault' method that should not be API.
IContextFunction An interface containing a single method 'compute'. ContextFuncton implements this interface but since we expect that clients will be implementing instances of this we should likely remove (deprecate?) this interface in favor of supplying the base class.
IEclipseContext The interface through which context information is accessed. There are far many methods here...are they all really needed ?
RunAndTrack An abstract class containing a single abstract mehtod 'changed' and a utility method 'runExternalCode' (should this be final?)