Sablon változók

A sablon változókat a sablon mintában lehet használni. Ha a sablon kiértékelése a saját környezetében történik, akkor a változók feloldódnak a konkrét értékükre. A változók meghatározásakor egyszerű és teljes szintaxis is használható:

Ha számos lehetséges megfelelés van egy változóhoz, akkor ezek mint ajánlatok jelenhetnek meg a felhasználó számára.

Általános sablon változók

A Java és a Javadoc környezet is meghatározza a következő változókat:

Változó leírása
${cursor} A kurzor pozícióját adja meg a sablonszerkesztés mód elhagyása után. Ez akkor hasznos, ha a sablonszerkesztés mód elhagyása után a kurzornak nem a sablon végére kellene ugrania, hanem máshová.
${date} Az aktuális dátumra értékelődik ki.
${dollar} A dollárjelre '$' értékelődik ki. Ennek alternatívájaként két dollárjel is használható: '$$'.
${enclosing_method} A beágyazó név nevére értékelődik ki.
${enclosing_method_arguments} A beágyazó metódus paraméterneveinek vesszővel elválasztott listájára értékelődik ki. Ez a változó akkor hasznos, ha sok metódus naplóutasítást készít.
${enclosing_package} A beágyazó csomag nevére értékelődik ki.
${enclosing_project} A beágyazó projekt nevére értékelődik ki.
${enclosing_type} A beágyazó típus nevére értékelődik ki.
${file} A fájl nevére értékelődik ki.
${line_selection} Az összes jelenleg kiválasztott sor tartalmát kiértékeli.
${primary_type_name} Az aktuális fordítási egység elsődleges típusára értékelődik ki.
${return_type} A beágyazó metódus visszatérési típusára értékelődik ki.
${time} Az aktuális időre értékelődik ki.
${user} A felhasználó nevére értékelődik ki.
${word_selection} Az aktuális szövegkijelölés tartalmára értékelődik ki.
${year} Az aktuális évre értékelődik ki.

Java-specifikus sablon változók

A Java környezet ezen túl meghatározza a következő változókat. Megjegyzés: Az alábbi táblázatban az id egy felhasználó által elnevezett új változó.

Változó leírása
${id:field(type)} Egy mezőre értékelődik ki a jelenlegi hatókörben, amely a megadott típus egy altípusa. Ha nincs megadva típus, akkor bármely nem primitív mező megfelel.

Például:
${count:field(int)}

${id:var(type)} Egy mezőbe, helyi változóba vagy paraméterre értékelődik ki, ami látható a jelenlegi hatókörben, amely a megadott típus egy altípusa. Ha nincs megadva típus, akkor bármely nem primitív változó megfelel.

Például:
${array:var(java.lang.Object[])}

${id:localVar(type)} Egy helyi változóba vagy paraméterre értékelődik ki, ami látható a jelenlegi hatókörben, amely a megadott típus egy altípusa. Ha nincs megadva típus, akkor bármely nem primitív helyi változó megfelel.

Az ${array} egy parancsikon az ${array:localVar(java.lang.Object[])} objektumhoz, de primitív típusok tömbjeinek is megfelel.
A ${collection} egy parancsikon a ${collection:localVar(java.util.Collection)} elemhez.
Az ${iterable} egy parancsikon az ${iterable:localVar(java.lang.Iterable)} elemhez, de tömbböknek is megfelel.

${id:argType(variable, n)} A hivatkozott sablon változó n-edik típus argumentumára értékelődik ki. A hivatkozásnak egy másik sablon változó nevének kell lennie. A java.lang.Object elembe oldódik fel, ha a hivatkozott változó nem található vagy nem paraméterezett típus.

Például:
${type:argType(vector, 0)} ${first:name(type)} = ${vector:var(java.util.Vector)}.get(0)

${id:elemType(variable)} A hivatkozott sablon változó elemtípusára értékelődik ki. A hivatkozásnak egy másik sablon változó nevének kell lennie, amely egy tömbbe vagy a java.lang.Iterable egy példányába oldódik fel. Az elemType változó típus hasonló az ${id:argType(reference,0)} típushoz, a különbség az, hogy a tömbök elemtípusát is feloldja.

Az ${array_type} a ${array_type:elemType(array)} parancsikonja.
Az ${iterable_type} az ${iterable_type:elemType(iterable)} parancsikonja.

${id:newName(reference)} A hivatkozás által megadott típusú, új helyi változó nem ütköző nevére értékelődik ki. A hivatkozás lehet Java típusú név, vagy egy másik sablon változó neve. Az előállított név megfelel a kód stílusbeállításainak.

Az ${index} az ${index:newName(int)} parancsikonja.
Az ${iterator} az ${iterator:newName(java.util.Iterator)} parancsikonja.
Az ${array_element} az ${array_element:newName(array)} parancsikonja.
Az ${iterable_element} az ${iterable_element:newName(iterable)} parancsikonja.

${array} A jelenlegi hatókörben látható tömb ajánlásra értékelődik ki.
${array_element} Egy új helyi változó nevére értékelődik ki az ${array} változó megfelelés egy eleméhez.
${array_type} Az ${array} változó megfelelés elemtípusára értékelődik ki.
${collection} A jelenlegi hatókörben látható kollekció egy ajánlatára értékelődik ki.
${index} Egy nem deklarált tömb index ajánlatra értékelődik ki.
${iterator} Egy java.util.Iterator típusú új helyi változó használaton kívüli nevére értékelődik ki.
${iterable} A jelenlegi hatókörben látható iterálható elem vagy tömb ajánlatra értékelődik ki.
${iterable_element} Egy új helyi változó nevére értékelődik ki az ${iterable} változó megfelelés egy eleméhez.
${iterable_type} Az ${iterable} változó megfelelés elemtípusára értékelődik ki.
${todo} A jelenleg megadott alapértelmezett feladat címke ajánlatára értékelődik ki.

Kapcsolódó fogalmak

Sablonok

Kapcsolódó leírás

Sablonok szerkesztése
Sablonok beállításai
Java tartalomsegéd
Feladat címke beállítások
Kódsablon beállítások
Kódstílus beállítások