Des variables de modèle peuvent être employées dabs le motif du modèle. Les variables sont résolues à leur valeur concrète lorsqu'il est procédé aux tests des résultats du modèle dans son contexte. Les variables peuvent être spécifiées en suivant une syntaxe simple ou complète :
${array}
Cela définit une variable de nom array qui se résoudra en tableau d'alignement (array). On pourra y faire référence à de multiples reprises tel quel.
${it:var(java.util.Iterator)}
Cela définit une variable nommée it qui se résoudra en variable locale de type java.util.Iterator. On pourra y faire référence à de multiples reprises en donnant seulement son nom sans le type : ${it}.
Les arguments dans les variables complètes peuvent être écrits textuellement s'ils sont des noms qualifiés ou des entiers. Si un argument comprend d'autres caractères ou espaces, il doit être placé entre apostrophes ('').
Si une variable répond à plusieurs possibilités, celles-ci peuvent apparaître comme propositions pour l'utilisateur.
Les contextes Java et Javadoc définissent les variables suivantes :
| Variable | Description |
|---|---|
| ${cursor} | Indique l'emplacement du curseur à la fermeture de la boîte de dialogue d'édition du modèle. Cette option est utile lorsque le curseur doit être amené à un autre emplacement que la fin du modèle à la fermeture de la boîte de dialogue d'édition du modèle. |
| ${date} | A pour résultat la date du jour. |
| ${dollar} | A pour résultat le symbole dollar $. On peut aussi utiliser deux symboles dollar : $$. |
| ${enclosing_method} | A pour résultat le nom de la méthode conteneur. |
| ${enclosing_method_arguments} | A pour résultat une liste de noms d'arguments de la méthode conteneur, séparés par des virgules. Cette variable peut être utile lors de la génération des instructions de consignation de nombreuses méthodes. |
| ${enclosing_package} | A pour résultat le nom du package conteneur. |
| ${enclosing_project} | A pour résultat le nom du projet conteneur. |
| ${enclosing_type} | A pour résultat le nom du type de conteneur. |
| ${file} | A pour résultat le nom du fichier. |
| ${line_selection} | Evalue le contenu de toutes les lignes sélectionnées. |
| ${primary_type_name} | A pour résultat le type primaire de nom de l'unité de compilation actuelle. |
| ${return_type} | A pour résultat le type de retour de la méthode conteneur. |
| ${time} | A pour résultat l'heure courante. |
| ${user} | A pour résultat le nom de l'utilisateur. |
| ${word_selection} | A pour résultat le contenu de la sélection de texte en cours. |
| ${year} | A pour résultat l'année en cours. |
Le contexte Java apporte un complément de définition aux variables suivantes. Remarque : dans le tableau ci-dessous, id est un nom choisi par l'utilisateur pour la variable qu'il a créée.
| Variable | Description |
|---|---|
| ${id:field(type[,type]*)} | A pour résultat une zone dans la portée en cours qui correspond à un sous-type de n'importe lequel des types donnés. Si aucun type n'est spécifié, toutes les zones non primitives sont acceptables.
Exemple : |
| ${id:var(type[,type]*)} | A pour résultat une zone, une variable locale ou un paramètre visible dans la portée en cours qui correspond à un sous-type de n'importe lequel des types donnés. Si aucun type n'est spécifié, toutes les variables non primitives sont acceptables.
Exemple : |
| ${id:localVar(type[,type]*)} | A pour résultat une variable locale ou un paramètre visible dans la portée en cours qui correspond à un sous-type de n'importe lequel des types donnés. Si aucun type n'est spécifié, toutes les variables locales non primitives sont acceptables.
${array} est la version abrégée de ${array:localVar('java.lang.Object[]')}, mais concorde aussi avec des tableaux d'alignement de types primitifs. |
| ${id:argType(variable, n)} |
Test les résultats vers le nième argument de type de la variable de modèle en référence. La référence doit être le nom d'une autre variable de modèle. Se résout en un élément java.lang.Object si la variable en référence est introuvable ou n'est pas de type paramétré.
Exemple : |
| ${id:elemType(variable)} | A pour résultat le type d'élément de la variable de modèle en référence.
La référence doit être le nom d'une autre variable de modèle
qui se résout en tableau ou en instance de java.lang.Iterable.
Le type de variable elemType est semblable à ${id:argType(reference,0)}, la différence
étant qu'il résout également le type d'élément d'un tableau.
${array_type} est la version abrégée de ${array_type:elemType(array)}. |
| ${id:newName(reference)} | A pour résultat un nom non conflictuel pour une nouvelle variable locale du type spécifié
par la référence. La référence peut être un nom de type Java ou le nom d'une autre variable de modèle. Le nom généré respecte les paramètres du style de code.
${index} est la version abrégée de ${index:newName(int)}. |
| ${id:newType(qualifiedTypeName)} | A pour résultat l'affectation à un type d'un nom de type Java qualifié complet.
Le résultat est un nom de type simple et le lancement de l'importation, s'il n'y a aucun conflit. Dans le cas contraire, le nom de type affecté est qualifié complet.
Exemple : |
| ${:import(type[,type]*)} |
Ajoute une instruction d'importation pour chaque type. Aucune action ne sera effectuée si l'importation existe déjà. Par contre, aucune action ne sera effectuée en cas de conflit d'importation.
Il n'y aura aucun résultat.
Exemple : |
| ${:importStatic([qualifiedName[,qualifiedName]*])} |
Ajoute une instruction d'importation statique pour chaque nom qualifié qui n'est pas encore importé. L'expression qualifiedName correspond au nom qualifié complet d'une zone ou d'une méthode statique ou bien au nom qualifié d'un type, auquel est accolé un suffixe .* entre apostrophes (''). Par contre, aucune action ne sera effectuée en cas de conflit d'importation.
Il n'y aura aucun résultat.
Exemple : |
| ${id:link(proposal[,proposal]*)} |
A pour résultat un ID si la liste des propositions est vide. Dans le cas contraire, le résultat correspond à la première proposition.
La valeur résultante est placée en mode lié.
Une fenêtre de proposition affiche l'ensemble des propositions données.
Exemple : |
| ${array} | A pour résultat une proposition pour le tableau visible dans la portée en cours. |
| ${array_element} | A pour résultat un nom pour la nouvelle variable locale d'un élément de la correspondance de variable ${array}. |
| ${array_type} | A pour résultat le type d'élément de la correspondance de variable ${array}match. |
| ${collection} | A pour résultat une proposition pour la collection visible dans la portée en cours. |
| ${exception_variable_name} | Nom de variable d'exception dans les blocs catch. |
| ${index} | A pour résultat une proposition pour un index de tableau non déclaré. |
| ${iterator} | A pour résultat un nom inusité pour une nouvelle variable locale de type java.util.Iteratore. |
| ${iterable} | A pour résultat une proposition pour un itérable ou un tableau visible dans la portée en cours. |
| ${iterable_element} | A pour résultat un nom pour la nouvelle variable locale d'un élément de la correspondance de variable ${iterable}. |
| ${iterable_type} | A pour résultat le type d'élément de la correspondance de variable ${iterable}match. |
| ${todo} | A pour résultat une proposition pour la balise de tâche par défaut actuellement indiquée. |


Edition des modèles
Page de préférences des modèles
Assistant de contenu Java
Préférences des balises de tâche
Préférences des modèles de code
Préférences de style de code