Java-redigerares mallvariabler

Det går att använda mallvariabler i mallmönstret. Variabler tolkas som sina konkreta värden när mallen utvärderas i sin kontext. Variabler kan anges med enkel eller fullständig syntax:

Om det finns flera möjliga matchningar för en variabel, presenteras de kanske som förslag för användaren.

Allmänna mallvariabler

Både Java- och Javadoc-kontexten definierar följande variabler:

Variabel Beskrivning
${cursor} Anger markörpositionen när mallens redigeringsläge stängs. Det här är användbart när markören ska hoppa till en annan plats än slutet på mallen när mallredigeringsläget stängs.
${date} Utvärderas till det aktuella datumet.
${dollar} Utvärderas till dollarsymbolen $. Som alternativ kan två dollartecken användas: $$
${enclosing_method} Utvärderas till namnet på omslutningsmetoden.
${enclosing_method_arguments} Utvärderas till en kommaseparerad lista på argumentnamn för omslutningsmetoden. Den här variabeln kan vara användbar när loggsatser genereras för många metoder.
${enclosing_package} Utvärderas till namnet på omslutningspaketet.
${enclosing_project} Utvärderas till namnet på omslutningsprojektet.
${enclosing_type} Utvärderas till namnet på omslutningstypen.
${file} Utvärderas till namnet på filen.
${line_selection} Utvärderas till innehållet i alla aktuella markerade rader.
${primary_type_name} Utvärderas till namnet på primärtypen för den aktuella kompileringsenheten.
${return_type} Utvärderas till returtypen för omslutningsmetoden.
${time} Utvärderas till den aktuella tiden.
${user} Utvärderas till användarnamnet.
${word_selection} Utvärderas till innehållet i den aktuella textmarkeringen.
${year} Utvärderas till det aktuella året.

Java-specifika mallvariabler

Java-kontexten definierar dessutom följande variabler. Anm. I följande tabell är id ett användarvalt namn på en ny variabel.

Variabel Beskrivning
${id:field(type[,type]*)} Utvärderas till ett fält i det aktuella omfånget som är en undertyp till någon av de angivna typerna. Om du inte anger någon typ matchas alla icke-primitiva fält.

Exempel:
${count:field(int)}

${id:var(type[,type]*)} Utvärderas till ett fält, en lokal variabel eller en parameter i det aktuella omfånget som är en undertyp till någon av de angivna typerna. Om du inte anger någon typ matchas alla icke-primitiva variabler.

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

${id:localVar(type[,type]*)} Utvärderas till en lokal variabel eller parameter i det aktuella omfånget som är en undertyp till någon av de angivna typerna. Om du inte anger någon typ matchas alla icke-primitiva lokala variabler.

${array} är ett kortkommando för ${array:localVar('java.lang.Object[]')}, men matchar också matriser av primitiva typer.
${collection} är ett kortkommando för ${collection:localVar(java.util.Collection)}.
${iterable} är ett kortkommando för ${iterable:localVar(java.lang.Iterable)}, men matchar också matriser.

${id:argType(variable, n)} Utvärderas till nth-typargumentet i den refererade mallvariabeln. Referensen bör vara namnet på en annan mallvariabel. Löses ut till java.lang.Object om det inte går att hitta den refererade variabeln eller om den inte är av en parametriserad typ.

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

${id:elemType(variable)} Utvärderas till elementtypen för den refererade mallvariabeln. Referensen bör vara namnet på en annan mallvariabel som löses ut till en matris eller till en förekomst av java.lang.Iterable. Variabeltypen elemType liknar ${id:argType(reference,0)}. Skillnaden är att den också löser ut en matris elementtyp.

${array_type} är ett kortkommando för ${array_type:elemType(array)}.
${iterable_type} är ett kortkommando för ${iterable_type:elemType(iterable)}.

${id:newName(reference)} Utvärderas till ett namn för en ny lokal variabel som inte är i konflikt med den typ som anges av referensen. Referensen kan vara antingen ett Java-typnamn eller namnet på en annan mallvariabel. Det genererade namnet följer kodformatsinställningarna.

${index} är ett kortkommando för ${index:newName(int)}.
${iterator} är ett kortkommando för ${iterator:newName(java.util.Iterator)}.
${array_element} är ett kortkommando för ${array_element:newName(array)}.
${iterable_element} är ett kortkommando för ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Utvärderas till ett typnamn från det fullständigt kvalificerade Java-typnamnet. Utvärderas till ett enkelt typnamn och en import om det inte finns någon typ i konflikt. Utvärderas till ett fullständigt kvalificerat typnamn i annat fall.

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

${:import(type[,type]*)} Lägger till en importsats för varje typ. Gör ingenting om importen redan finns. Utför inget om det finns en import i konflikt. Utvärderas till ingenting.

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

${:importStatic([qualifiedName[,qualifiedName]*])} Lägger till en statisk importsats för alla kvalificerade namn som inte är importerade. qualifiedName är det fullständiga namnet för ett statiskt fält eller metod eller är det fullständiga namnet för en typ plus ett .*-suffix omslutet av enkla citatteckenn ''. Utför inget om det finns en import i konflikt. Utvärderas till ingenting.

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

${id:link(proposal[,proposal]*)} Utvärderas till id listan med förslag är tom, i annat fall utvärderas till det första förslaget. Det utvärderade värdet placeras i länkat läge. Alla angivna förslag visas i ett förslagsfönster.

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

${array} Utvärderas till ett förslag för en matris som syns i det aktuella omfånget.
${array_element} Utvärderas till ett namn för en ny lokal variabel för ett element till den ${array}-variabel som matchar.
${array_type} Utvärderas till elementtypen för den ${array}-variabel som matchar.
${collection} Utvärderas till ett förslag för en samling som syns i det aktuella omfånget.
${exception_variable_name} Variabelnamn för undantag i catch-block.
${index} Utvärderas till ett förslag på ett odeklarerat matrisindex.
${iterator} Utvärderas till ett oanvänt namn för en ny lokal variabel av typen java.util.Iterator.
${iterable} Utvärderas till ett förslag för ett iterable-objekt eller en matris som syns i det aktuella omfånget.
${iterable_element} Utvärderas till ett namn för en ny lokal variabel för ett element till den ${iterable}-variabel som matchar.
${iterable_type} Utvärderas till elementtypen för den ${iterable}-variabel som matchar.
${todo} Utvärderas till ett förslag för det aktuella angivna standarduppgiftsmärkordet.

Närliggande begrepp

Mallar

Närliggande referens

Redigera mallar
Inställningssidan Mallar
Java-innehållsassistenten
Inställningar för uppgiftsmärkord
Kodmallsinställningar
Kodformatsinställningar