Quelltext der Seite Beispiel MUT Classpath Container

Dieses Beispiel erläutert lediglich die auf der Seite [[Classpath Repräsentation in Eclipse]] beschriebenen Konzepte. Es ist nicht weiter angepasst und aus meiner Masterarbeit übernommen. Ziel des Containers ist es eine Bibliothek MUT.jar, die in einem Plugin liegt, im Classpath der Java Projekte verfügbar zu machen, die in der Eclipse Installation angelegt werden, in der das Plugin installiert ist.

== Der MUT Classpath Container ==
Um die @MUT Annotation auflösen zu können, muss diese im Erstellungspfad des Eclipse-Java-Projekts, in dem die Testmethode liegt, vorhanden sein. Dem Eclipse-Projekt muss also ein ''Classpath Entry ''für die JAR-Bibliothek hinzugefügt werden, der die Annotation enthält. Die verschiedenen Typen von ''Classpath Entries'' sind im Anhang A1 beschrieben.

Für eine Einbindung ohne das Hantieren mit Pfaden zu JAR-Dateien innerhalb des Eclipse-Plugins stehen zwei Typen von ''Classpath Entries'' zur Auswahl: ''Variable Classpath Entries ''und ''Classpath Container Entries''. Obwohl ersterer Typ für die Einbindung einer einzelnen JAR-Bibliothek ausreichend wäre, kommt in diesem Plugin ein ''Classpath Container'' zum Einsatz. Die Nutzung von ''Classpath Containern'' ist in Eclipse weiter verbreitet und kommt auch für das Hinzufügen der Bibliotheken für JUnit zum Einsatz. Daher ist durch die Erstellung eines ''Classpath Containers'' eine konsistente Bedienung gewährleistet, die bei Interesse sogar in der Form erweitert werden kann, dass der MUT-Container neben der Annotation auch gleich die JUnit ''Classpath Entries'' mitbringen kann – alternativ wäre natürlich auch denkbar die Annotation zum Junit-Classpath-Container hinzuzufügen.

Ein ''Classpath Container ''kann einem Java-Projekt über die Erstellungspfad-Seite des Eigenschaftsdialogs des Projekts hinzugefügt werden. Abbildung 1 zeigt das Hinzufügen des ''Containers'' MUT, der von diesem Plugin bereit gestellt wird. Was für diese Bereitstellung konkret benötigt wird, ist im folgenden beschrieben. 

[[Image:Add_Library_Dialog.jpg|none|frame|''Abbildung 1: Hinzufügen der MUT- Bibliothek zu einem Java Projekt'']]


Die Definition eines ''Classpath Containers'' setzt sich aus zwei Teilen zusammen: der Implementierung der Erweiterungspunkte

* <tt>org.eclipse.jdt.ui.classpathContainerPage</tt> und
* <tt>org.eclipse.jdt.core.classpathContainerInitializer</tt>

 1: <extension point="org.eclipse.jdt.ui.classpathContainerPage">
 2:      <classpathContainerPage class="org.projectory.ezunit.internal.BuildPath.MUTClasspathContainerPage"
 3:                              id="org.projectory.ezunit.MUT_CONTAINER"
 4:                              name="MUT"/>
 5: </extension>

 <b>''Listing 1: Defintion der Classpath Container Page für die Bibliothek MUT''</b>


Listing 1 zeigt die Definition der ''Classpath Container Page'' für die Bibliothek MUT. In der Zeile 1 ist angegeben, dass es sich um eine Erweiterung für den Erweiterungspunkt <tt>org.eclipse.jdt.ui.classpathContainerPage</tt> handelt. In Zeile 4 wird der Name angegeben, der in der Liste aus Abbildung 1 zu sehen ist. Die Zeile 2 enthält den voll qualifizierten Namen einer Klasse, die das Interface <tt>org.eclipse.jdt.ui.wizards.IClasspathContainerPage</tt> implementiert. Sie stellt eine Seite für den Wizard aus Abbildung 1 bereit, auf der weitere Informationen zu dem hinzugefügten ''Container ''eingegeben werden können. Für den von Eclipse bereitgestellten ''Container'' „JRE System Library“ wird auf dieser Seite zum Beispiel die ''Java Runtime Environment'' ausgewählt, deren Bibliotheken dem Erstellungspfad des Projekts hinzugefügt werden sollen. Da für die @MUT Annotation keine weiteren Einstellungen nötig sind, fällt diese Seite, wie in Abbildung 2 ersichtlich, optisch sehr einfach aus.

[[Image:Add_ClasspathContainer_Page.jpg|none|frame|''Abbildung 2: Wizard Seite für das Hinzufügen des Bibliothek für die @MUT Annotation'']]


In der Zeile 3 findet sich letztendlich die ID des ''Containers'', der dem Projekt durch diese Wizard-Seite hinzugefügt werden soll. Diese ID muss identisch mit der ID sein, die für den <tt>classpathContainerInitializer</tt> angegeben ist, der weiter unten beschrieben wird. 

Da die Klasse <tt>MUTClassPathContainerPage</tt> als zweites Interface auch noch <tt>org.eclipse.core.runtime.IExecutableExtension</tt> implementiert, kann die so angegebene ID in der Methode <tt>setInitializationData(...)</tt> ausgelesen werden. Auf Basis dieser ID kann dann ein <tt>org.eclipse.jdt.core.IClasspathEntry</tt> erzeugt werden, der von der Methode <tt>getSelection()</tt> als Ergebnis der Wizard-Seite zurück gegeben wird. Der übliche Typ für solch eine Wizard-Seite ist ein ''Container Classpath Entry''.

Die tatsächliche Auflösung dieses <tt>IClasspathEntry</tt> Objekts in eine Menge von JAR-Bibliotheken, Quellcode-Ordnern und Projektreferenzen wird von der Klasse durchgeführt, die in der Erweiterung des Erweiterungspunkts <tt>org.eclipse.jdt.core.ClasspathContainerInitializer</tt> angegeben ist. In Listing 2 wird so die Klasse <tt>MUTClasspathContainerInitializer</tt> als die Klasse angegeben, die die Auflösung für ''Classpath Container'' ''Entries ''mit der ID <tt>org.projectory.ezunit.MUT_CONTAINER </tt>übernimmt. 

 1: <extension point="org.eclipse.jdt.core.
 2:                   classpathContainerInitializer">
 3:     <classpathContainerInitializer
 4:          class="org.projectory.ezunit.internal.
 5:          buildPath.MUTClasspathContainerInitializer"
 6:          id="org.projectory.ezunit.MUT_CONTAINER"/>
 7: </extension>

 <b>''Listing 2: Defintion der Classpath Container Initializers für die Bibliothek MUT''</b>

Die so spezifizierte Klassse muss dabei eine Subklasse der Klasse <tt>org.eclipse.jdt.core.ClasspathContainerInitializer</tt> sein und deren abstrakte Methode <tt>initialize(...)</tt> implementieren. Aufgabe dieser Methode ist es, dem übergebenen <tt>IJavaProject</tt> einen <tt>IClasspathContainer</tt> hinzuzufügen. Konkret wird dem übergebenen Projekt von der Klasse <tt>MUTClasspathContainerInitializer</tt> eine Instanz der internen Klasse <tt>MUTContainer</tt> hinzugefügt, die im wesentlichen nur den Namen des ''Classpath Containers ''und einen ''Library Classpath Entry'' zurück gibt, der die JAR-Bibiothek <tt>lib/MUT.jar</tt> im Plugin referenziert. Da die weitere Implementierung dieser Klasse selbst erklärend ist, soll an dieser Stelle nicht näher darauf eingegangen werden. 

Über den so hinzugefügten ''Classpath Container'' steht jetzt allen Java Klassen in diesem Projekt die Annotation <tt>@MUT</tt> zur Verfügung. Damit kann sie verwendet werden, um Testmethoden mit denen von ihr getesteten Methoden zu verknüpfen.
[[Kategorie:Classpath]]