Annotations en Java

Voir aussi :

• Les annotations de Java 5
• An Introduction to Java Annotations par M. M. Islam Chisty

• un mélange entre les commentaires et le code lui-même
• elles ne changent pas la sémantique du programme mais elles modifient la manière dont le programme est traité par des outils et des librairies, ce qui peut modifier la sémantique de l'exécution;
  c'est un mécanisme qui associe un meta-marquer avec un élément de programme et permet au compilateur ou à la MV d'extraire le comportement pour les éléments marqués.
• la possibilité d'effectuer des vérifications à la compilation
• on peut appliquer les annotations à toutes les déclarations du code : classes, interfaces, méthodes, membres, constructeurs. Il suffit de faire précéder la déclaration de l'annotation.
• utilisées par Javadoc, JUnit, ...
• une annotation est composée du caractère '@' suivi par un type d'annotation et possiblement, une liste de paires élément-valeur entourée de parenthèses
• les annotations standards (utilisées par le compilateur) : @Deprecated, @Override, @SuppressWarnings
  

        @Deprecated     // cette classe est obsolète
        public class ARemplacer { }
        // ...
        ARemplacer obj = new ARemplacer();
        

• La définition d'un type d'annotation est composée du caractère '@' suivi du mot-clé 'interface', du nom de type et des déclarations des éléments.
  

          import java.lang.annotation.*; // pour pouvoir utiliser @Documented
          @Documented  // pour faire paraître cette info dans Javadoc
          @interface Preambule {
          String auteur();
          String date();
          int versionActuelle() default 1;
          String derniereModification() default "N/A";
        }
        

  Un exemple d'utilisation de ce type :

        @Preambule (
          auteur = "John Doe",
          date = "9/14/1900",
          versionActuelle = 77,
          derniereModification = "9/04/2008"
        )
        public class Exemple {
          // code de la classe
        }
        

  L'avantage : la documentation javadoc produite pour cette classe aurait le format suivant :

        @Exemple(auteur="John Doe",
                 date="9/14/1900",
                 versionActuelle=77,
                 derniereModification="9/04/2008")
        public class Exemple
        

• trois types d'annotations :
  • marqueurs - des méta données identifiées par un simple nom, comme @Deprecated
  • les annotations paramétrées - disposent d'une donnée supplémentaire que le programmeur peut choisir
  • les annotations multi paramétrées - plusieurs paramètres possibles

          @NotNull(argument="file", message="Le fichier ne peut être null.")