Classes BeanInfo et introspection

Si vous créez des composants ou des beans pour les utiliser dans l'éditeur visuel (par exemple, en ajoutant des composants à la palette), vous pouvez contrôler leur comportement en fournissant une classe BeanInfo.

Une classe BeanInfo class implémente java.beans.BeanInfo et permet à l'éditeur visuel de déterminer le comportement de la vue Propriétés du bean et d'indiquer si un module de personnalisation est disponible. L'éditeur visuel inclut des classes BeanInfo pour les contrôles AWT et Swing courants.

Comme la classe BeanInfo contient des informations utilisées uniquement lors de la conception, elle est généralement stockée dans un projet différent de celui de la classe du bean et n'est pas incluse lorsque le bean est déployé. L'éditeur visuel Java utilise un certain nombre de règles pour vous permettre d'associer les classes BeanInfo aux beans Java qu'elles décrivent. Vous devez maîtriser ces règles si vous utilisez des beans Java associés à des classes BeanInfo que l'éditeur visuel doit détecter. C'est le cas, par exemple, si vous utilisez un ensemble de classes de beans Java provenant d'un tiers ou que vous avez développé les beans Java et les classes BeanInfo que vous utilisez.

Pour mieux connaître les classes BeanInfo, vous pouvez télécharger la spécification JavaBeans sur le site java.sun.com/products/javabeans/docs/.

Informations de base

La classe java.beans.Introspector est utilisée pour localiser la classe BeanInfo d'un bean Java. La phase pendant laquelle cette opération est effectuée s'appelle l'introspection et est exécutée par l'éditeur visuel la première fois qu'un bean est utilisé. Par exemple, lorsque vous faites glisser un bouton pour la première fois à partir de la palette, une introspection est effectuée pour tenter de localiser la classe BeanInfo appropriée. Une fois l'introspection du bean terminée, les résultats sont placés en mémoire cache pour optimiser les performances. Toutefois, lorsque l'éditeur visuel détecte que la classe BeanInfo a été modifiée et que la mémoire cache est obsolète, l'introspection est à nouveau exécutée.

L'introspection d'un bean est effectuée en appelant la méthode statique getBeanInfo(Class) avec la classe bean sous forme d'argument. Exemple :

java.beans.Introspector.getBeanInfo(MyJavaBean.class)

Le programme d'introspection utilise la logique suivante pour localiser une classe BeanInfo de la classe d'argument MyJavaBean. Si le test est concluant, le programme d'introspection cesse la recherche. Si une étape du test échoue, le programme d'introspection passe au test suivant pour rechercher la classe BeanInfo. Il utilise les tests logiques suivants :

Si le bean implémente lui-même java.beans.BeanInfo, celle-ci est utilisée. Toutefois, ce scénario se produit rarement car cela signifie que la classe d'exécution MyJavaBean contient les informations relatives à la phase de conception qui seront incluses lors du déploiement alors qu'elles ne sont pas nécessaires.
Si une classe comporte le même nom que la classe d'argument, et que la chaîne BeanInfo est ajoutée au nom (par exemple, MyJavaBeanBeanInfo), elle est utilisée comme classe BeanInfo. Cet élément est d'abord recherché dans le même package de la classe et s'il est introuvable, il est localisé au sein d'un chemin de recherche défini. Au lieu d'utiliser le chemin de classe d'une machine virtuelle Java pour rechercher la classe BeanInfo, Le programme d'introspection possède sa propre liste de packages dans lesquels la recherche doit être effectuée. Ce chemin représente le chemin de recherche BeanInfo. Le programme d'introspection ne réutilise pas le chemin de classe pour maintenir les informations d'exécution et de la phase de conception séparées.
Si aucune classe BeanInfo n'est localisée pour la classe immédiate soumise à l'introspection, le programme d'introspection tente de la localiser pour la superclasse.
Si aucune classe BeanInfo n'est localisée pour la classe immédiate soumise à l'introspection, une classe par défaut est créée. La valeur par défaut utilise les résultats de l'introspection de la superclasse immédiate et les fusionne avec les résultats des propriétés par défaut de la classe immédiate. Les règles utilisées pour créer des propriétés par défaut consistent à associer les méthodes get et set à des noms et à des arguments compatibles. Par exemple, les méthodes public void setName(String aName) et public String getName() sont associées pour créer une propriété appelée name. La classe BeanInfo créée n'est pas stockée sous forme de classe dans un package. Elle correspond à une instance transitoire utilisée comme description temporaire des informations de phase de conception pour permettre à l'éditeur visuel d'extraire la liste des propriétés et d'autres informations.

Si une classe BeanInfo est détectée pour la classe, Le programme d'introspection ne la renvoie pas explicitement. A la place, il utilise les informations associées pour créer une classe de résultat temporaire qui implémente java.beans.BeanInfo.

Chemin de recherche BeanInfo

Le meilleur moyen de comprendre le chemin BeanInfo est de prendre en compte la machine virtuelle Java créée pour effectuer l'introspection. La machine virtuelle dispose d'un chemin de classe composé des entrées suivantes :

Les éléments indiqués dans le chemin de compilation du projet.
Les éléments indiqués dans les classes BeanInfo du chemine BeanInfo du projet.
Tous les éléments exportés des classes BeanInfo pour tous les projets du chemin de compilation Java.

Après avoir créé la machine virtuelle java.beans.Introspector définit sa liste de packages à utiliser pour la recherche de classes BeanInfo avec la méthode public void setSearchPath(String[]).

Les arguments associés à cette méthode sont les suivants :

Les éléments inclus dans la liste des packages dans le chemin BeanInfo du projet.
Tous les éléments exportés dans les listes de packages des projets dans le chemin de compilation Java.

BeanInfo et attributs inhérents

Si le bean que vous écrivez hérite des attributs d'une superclasse, l'élément BeanInfo par défaut n'expose pas les attributs inhérents. Vous devez les exposer explicitement avec la méthode getAdditionalBeanInfo().

Exemple :

public BeanInfo[] getAdditionalBeanInfo() {
try {                 
         // Renvoie tous les dispositifs hérités.                 
         return new BeanInfo[] {
Introspector.getBeanInfo(MyPanel.class.getSuperclass())};
} catch (IntrospectionException e) {            
return new BeanInfo[0];            
}

Si un attribut inhérent n'est pas exposé, l'éditeur visuel ne le prend pas en compte, même s'il n'est pas défini dans le code source.