Découverte de WOJ pour Eclipse

World of Java est un projet dont le concept est de donner un accès à la javadoc et aux sources d'un grand nombre de projets Java. Actuellement, la base de données de WOJ compte plus de 3600 révisions de projets. Les projets en questions sont nombreux et divers, on peut par exemple citer Jasper Reports, Hibernate, JFace, JDIC, SwingX ou encore IText.

La grande force de WOJ est son intégration dans les IDE, cela permet de gagner beaucoup de temps. En effet, plus besoin de rechercher la documentation d'un projet puisqu'on peut la trouver directement dans son IDE.

Dans cet article, nous allons parler du plugin pour Eclipse, mais sachez qu'il existe aussi une version pour Netbeans et une version pour IntelliJ Idea. WOJ fournit même un ensemble de tâches pour Ant.

WOJ est un programme payant, une version de démo est toutefois disponible pour un mois, passé ce délai, il vous faudra payer pour continuer à l'utiliser. Vous pouvez néanmoins obtenir une version gratuite pour les projets open source ou pour usage personnel.

Avant toute chose, il faudra bien sûr installer WOJ. Pour cela, rien de bien compliqué, il suffit de l'installer via l'update site.

Pour ce faire, allez dans le menu "Help", "software updates" et ensuite "Find and install". Sélectionnez ensuite la deuxième option ("Search for new features to install"). Ajoutez un nouveau site avec les infos suivantes :

Ensuite, il vous suffit de sélectionner ce site et de cliquer sur "finish". Choisissez ensuite le plugin WOJ qui devrait être arrivé dans la liste. A l'heure où j'écris cet article, la dernière version est la 1.1.2. Cliquez sur "next" et indiquez ensuite que vous acceptez les termes de la licence. Cliquez ensuite sur finish et attendez que l'installation soit terminée.

Maintenant que vous avez installé WOJ, il va falloir le configurer. Normalement, la fenêtre des préférences de WOJ devrait s'afficher d'elle même au prochain lancement d'Eclipse, sinon, vous pouvez l'ouvrir depuis le menu WOJ en cliquant sur préférences.

Remplissez maintenant vos infos de connexion ou créez un nouveau compte en utilisant l'onglet créer un compte WOJ. Valider votre compte. La date de fin de votre licence va s'afficher sous vos identifiants de connexion.

Si vous avez un proxy, il vous faut le configurer dans le sous menu de WOJ dans l'arbre à gauche.

Voilà, c'est tout ce que vous avez besoin de faire pour configurer WOJ, on peut maintenant passer à l'utilisation.

La première utilisation de WOJ est de pouvoir afficher la javadoc d'une classe soit standard soit d'un projet référencé par WOJ. Il suffit pour cela d'utiliser la combinaison Shift+F3 ou l'item correspondant du menu WOJ après avoir sélectionné une classe dans votre code. WOJ va ensuite ouvrir l'explorateur sur la javadoc de l'item en question. Vous pouvez bien sûr utiliser cela pour des constructeurs et des méthodes.

Une autre fonction de WOJ est de pouvoir visualiser les sources des divers projets de la base de données. Pour faire cela, aller dans le menu WOJ et choisissez l'explorateur de modules. Ensuite, dans la nouvelle vue qui est apparu, il vous faut choisir l'organisation puis le nom du projet que vous voulez visualiser. Et enfin choisissez la version dont vous désirez les sources. Il ne vous reste qu'à choisir la classe que vous désirez voir dans l'explorateur de package du projet. Double cliquez sur cette classe et vous en verrez le code source.

Vous pouvez aussi faire cela directement dans un de vos projets qui utilise un librairie d'un des projets de WOJ. Si vous faites un Ctrl-clic pour visualiser la source d'une classe dont vous n'avez pas lié les sources, mais qui est dans WOJ, c'est WOJ qui vous affichera la source de la classe en question.

Vous pouvez aussi ajouter dans la base de données de WOJ des projets qui n'y sont pas encore. Si vous demandez à ouvrir la déclaration d'un projet qui ne se trouve pas dans la base de données WOJ, WOJ vous proposera de l'ajouter. D'abord, ce module sera ajouté à votre espace restreint et dès que l'équipe de WOJ aura validé le nouveau module, il sera visible de tous.

La dernière chose à savoir est que vous pouvez disposer d'un espace restreint avec la version professionelle. En effet, vous pourrez ajouter dans un espace privé accessible que par vous et votre équipe, les sources et la documentation de votre projet.

En conclusion, je vous conseille d'essayer WOJ vous en serez à coup sûr séduit. Vous n'aurez plus besoin de rechercher les sources des projets que vous utilisez ni leur javadoc.

Je vous invite à consulter le site officiel de WOJ pour plus d'informations.