Sjabloonvariabelen in Java-editor

U kunt sjabloonvariabelen gebruiken in het sjabloonpatroon. Bij het evalueren van een sjabloon in de context worden de variabelen omgezet in de feitelijke waarden. U kunt variabelen eenvoudig of volledig opgeven:

Wanneer er meerdere overeenkomsten voor een variabele zijn, worden deze als suggesties aangeboden.

Algemene sjabloonvariabelen

Zowel de Java-context als de Javadoc-context ondersteunt de volgende variabelen:

Variabele Beschrijving
${cursor} Geeft de cursorpositie aan als de bewerkmodus links is. Dit is handig als de cursor bij het afsluiten van de bewerkmodus naar een andere positie moet verspringen dan het einde van de sjabloon.
${date} Resulteert in de huidige datum.
${dollar} Resulteert in het dollarteken $. U kunt ook twee dollartekens gebruiken: $$.
${enclosing_method} Resulteert in de naam van de insluitende methode.
${enclosing_method_arguments} Resulteert in een lijst van door komma's gescheiden argumentnamen van een insluitende methode. Deze variabele kan handig zijn als u logboekinstructies genereert voor een groot aantal methoden.
${enclosing_package} Resulteert in de naam van een insluitend pakket.
${enclosing_project} Resulteert in de naam van een insluitend project.
${enclosing_type} Resulteert in de naam van een insluitend type.
${file} Resulteert in de naam van een bestand.
${line_selection} Resulteert in de content van alle geselecteerde regels.
${primary_type_name} Resulteert in de naam van het primaire type van de huidige compilatie-eenheid.
${return_type} Resulteert in het retourtype van een insluitende methode.
${time} Resulteert in de huidige tijd.
${user} Resulteert in de gebruikersnaam.
${word_selection} Resulteert in de content van de huidige tekstselectie.
${year} Resulteert in het huidige jaar.

Java-specifieke sjabloonvariabelen

De Java-context definieert verder de volgende variabelen. Opmerking: In de onderstaande tabel duidt id een door uzelf gekozen naam aan voor de variabele.

Variabele Beschrijving
${id:field(type[,type]*)} Resulteert in een veld in het huidige bereik dat een subtype is van een van de opgegeven typen. Als geen type is opgegeven, komt elk niet-primitief veld overeen.

Voorbeeld:
${count:field(int)}

${id:var(type[,type]*)} Resulteert in een veld, een lokale variabele of een parameter in het huidige bereik dat een subtype is van een van de opgegeven typen. Als geen type is opgegeven, komt elke niet-primitieve variabele overeen.

Voorbeeld:
${container:var(java.util.List, 'java.lang.Object[]')}

${id:localVar(type[,type]*)} Resulteert in een lokale variabele of een parameter in het huidige bereik dat een subtype is van een van de opgegeven typen. Als geen type is opgegeven, komt elke niet-primitieve lokale variabele overeen.

${array} is een verkorte schrijfwijze voor ${array:localVar('java.lang.Object[]')}, maar de eerste schrijfwijze komt ook overeen met arrays van primitieve typen.
${collection} is een verkorte schrijfwijze voor ${collection:localVar(java.util.Collection)}.
${iterable} is een verkorte schrijfwijze voor ${iterable:localVar(java.lang.Iterable)}, maar de eerste schrijfwijze komt ook overeen met arrays.

${id:argType(variable, n)} Resulteert in het n-de type-argument van de sjabloonvariabele waarnaar wordt verwezen. De verwijzing moet de naam zijn van een andere sjabloonvariabele. Als de gerefereerde variabele niet is gevonden of niet van een geparametriseerd type is, resulteert de code in java.lang.Object.

Voorbeeld:
${type:argType(vector, 0)} ${first:name(type)} = ${vector:var(java.util.Vector)}.get(0)

${id:elemType(variable)} Resulteert in het elementtype van een sjabloonvariabele waarnaar wordt verwezen. De verwijzing moet de naam zijn van een andere sjabloonvariabele die kan worden omgezet in een array of een instance van java.lang.Iterable. Het variabeletype elemType is vergelijkbaar met ${id:argType(verwijzing,0)}, maar het wordt ook omgezet in het elementtype van arrays.

${array_type} is een verkorte schrijfwijze voor ${array_type:elemType(array)}.
${iterable_type} is een verkorte schrijfwijze voor ${iterable_type:elemType(iterable)}.

${id:newName(reference)} Resulteert in een niet-strijdige naam voor een nieuwe lokale variabele van het type dat door de verwijzing wordt opgegeven. De verwijzing kan de naam zijn van een Java-type of een andere sjabloonvariabele. De gegenereerde naam voldoet aan de instellingen voor de codestijl.

${index} is een verkorte schrijfwijze voor ${index:newName(int)}.
${iterator} is een verkorte schrijfwijze voor ${iterator:newName(java.util.Iterator)}.
${array_element} is een verkorte schrijfwijze voor ${array_element:newName(array)}.
${iterable_element} is een verkorte schrijfwijze voor ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Resulteert in een volledig gekwalificeerde Java-typenaam. Resulteert in een eenvoudige typenaam en een importbewerking als er geen strijdig type aanwezig is. Resulteert anders in een volledig gekwalificeerde typenaam.

Voorbeeld:
${type:newType(java.util.Iterator)}

${:import(type[,type]*)} Voegt een importeerinstructie toe voor elk type. Doe niets als de importeerinstructie al bestaat. Doe niets als er een tegenstrijdige importeerinstructie bestaat. Resulteert in niets.

Voorbeeld:
${:import(java.util.List, java.util.Collection)}

${:importStatic([qualifiedName[,qualifiedName]*])} Voegt een statische importinstructie toe voor elke gekwalificeerde naam die nog niet is geïmporteerd. qualifiedName staat voor de volledige (fully qualified) naam van een statisch(e) veld of methode of het is de volledige naam van een type plus het suffix .* tussen enkele aanhalingstekens ''. Doet niets als er een tegenstrijdige importeerinstructie bestaat. Resulteert in niets.

Voorbeeld:
${is:importStatic(java.util.Collections.EMPTY_SET, 'java.lang.System.*')}

${id:link(proposal[,proposal]*)} Resulteert in id als de lijst met voorstellen leeg is en resulteert anders in het eerste voorstel. De resulterende waarde wordt in de gekoppelde werkstand geplaatst. Alle voorstellen worden in een venster afgebeeld.

Voorbeeld:
java.util.Collections.${kind:link(EMPTY_SET, EMPTY_LIST, EMPTY_MAP)}

${array} Resulteert in een suggestie voor een array die zichtbaar is binnen het huidige bereik.
${array_element} Resulteert in een naam van een nieuwe lokale variabele voor een element van de variabele die overeenkomt met ${array}.
${array_type} Resulteert in het elementtype van de variabele die overeenkomt met ${array}.
${collection} Resulteert in een suggestie voor een collectie die zichtbare is binnen het huidige bereik.
${exception_variable_name} Variabelenaam van uitzondering in catch-blokken.
${index} Resulteert in een suggestie voor een index van een niet-gedeclareerde array.
${iterator} Resulteert in een ongebruikte naam voor een nieuwe lokale variabele van het type java.util.Iterator.
${iterable} Resulteert in een suggestie voor een doorloopbaar object of een array in het huidige bereik.
${iterable_element} Resulteert in een naam van een nieuwe lokale variabele voor een element van de variabele die overeenkomt met ${iterable}.
${iterable_type} Resulteert in het elementtype van de variabele die overeenkomt met ${iterable}.
${todo} Resulteert in een suggestie voor de momenteel opgegeven standaardtaaktag.

Verwante concepten

Sjablonen

Verwante onderwerpen

Sjablonen bewerken
Voorkeurenpagina voor sjablonen
Java-contenthulp
Voorkeurenpagina Taaktags
Voorkeurenpagina Codesjablonen
Voorkeurenpagina Codestijl