Java-muokkausohjelman mallipohjan muuttujat

Voit käyttää mallipohjan mallissa mallipohjan muuttujia. Järjestelmä selvittää muuttujien varsinaisen arvon, kun se laskee mallipohjan kontekstissa. Voit määrittää muuttujia joko perussyntaksilla tai täyssyntaksilla:

Jos muuttujalla on useita mahdollisia vastineita, järjestelmä voi näyttää ne käyttäjälle ehdotuksina.

Mallipohjan yleiset muuttujat

Seuraavat muuttujat määräytyvät sekä Java- että Javadoc-kontekstin mukaan:

Muuttuja Kuvaus
${cursor} Määrittää kohdistimen sijainnin poistuttaessa mallipohjan muokkaustilasta. Tästä on hyötyä silloin, kun kohdistimen pitää siirtyä toiseen paikkaan mallipohjan lopun sijasta poistuttaessa mallipohjan muokkaustilasta.
${date} Arvoksi tulee kuluva päivämäärä.
${dollar} Arvoksi tulee dollarin tunnus $. Voit vaihtoehtoisesti käyttää kahta dollarin tunnusta $$.
${enclosing_method} Arvoksi tulee sisällytysmetodin nimi.
${enclosing_method_arguments} Arvoksi tulee sisällytysmetodin argumenttien nimien pilkuilla erotettu luettelo. Tästä muuttujasta voi olla hyötyä muodostettaessa lokilauseita useita metodeja varten.
${enclosing_package} Arvoksi tulee sisällytyspaketin nimi.
${enclosing_project} Arvoksi tulee sisällytysprojektin nimi.
${enclosing_type} Arvoksi tulee sisällytystyypin nimi.
${file} Arvoksi tulee tiedoston nimi.
${line_selection} Arvoksi tulee kaikkien valittuna olevien rivien sisältö.
${primary_type_name} Arvoksi tulee nykyisen käännösyksikön nimen alkeistyyppi.
${return_type} Arvoksi tulee sisällytysmetodin palautustyyppi.
${time} Arvoksi tulee kellonaika.
${user} Arvoksi tulee käyttäjätunnus.
${word_selection} Arvoksi tulee nykyisen tekstivalinnan sisältö.
${year} Arvoksi tulee kuluva vuosi.

Mallipohjan Java-muuttujat

Seuraavat muuttujat määräytyvät myös Java-kontekstin mukaan: Huomautus: Seuraavassa taulukossa tunnus on käyttäjän valitsema uuden muuttujan nimi.

Muuttuja Kuvaus
${id:field(type[,type]*)} Arvoksi tulee käytössä olevan laajuuden kenttä, joka on jonkin määritetyn tyypin alatyyppi. Jos tyyppiä ei ole määritetty, järjestelmä palauttaa jonkin kentän, jonka tyyppi on jokin muu kuin alkeistyyppi.

Esimerkki:
${count:field(int)}

${id:var(type[,type]*)} Arvoksi tulee käytössä olevassa laajuudessa näkyvissä oleva kenttä, paikallismuuttuja tai parametri, joka on jonkin määritetyn tyypin alatyyppi. Jos tyyppiä ei ole määritetty, järjestelmä palauttaa jonkin muuttujan, jonka tyyppi on jokin muu kuin alkeistyyppi.

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

${id:localVar(type[,type]*)} Arvoksi tulee käytössä olevassa laajuudessa näkyvissä oleva paikallismuuttuja tai parametri, joka on jonkin määritetyn tyypin alatyyppi. Jos tyyppiä ei ole määritetty, järjestelmä palauttaa jonkin paikallismuuttujan, jonka tyyppi on jokin muu kuin alkeistyyppi.

${array} on lyhyt muoto määrityksestä ${array:localVar('java.lang.Object[]')}, mutta se vastaa myös alkeistyyppien arvotaulukoita.
${collection} on lyhyt muoto määrityksestä ${collection:localVar(java.util.Collection)}.
${iterable} on lyhyt muoto määrityksestä ${iterable:localVar(java.lang.Iterable)}, mutta se vastaa myös arvotaulukoita.

${tunnus:argType(muuttuja, n)} Arvoksi tulee viitatun mallipohjan muuttujan n:s tyyppiargumentti. Viitteen tulisi olla toisen mallipohjan muuttujan nimi. Tuloksena on java.lang.Object, jos viitattua muuttujaa ei löydy tai sen tyyppi ei ole parametrisoitu.

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

${id:elemType(variable)} Arvoksi tulee viitatun mallipohjan muuttujan elementtilaji. Viitteen tulisi olla sellaisen toisen mallipohjan muuttujan nimi, jonka tuloksena on arvotaulukko tai java.lang.Iterable-ilmentymä. Muuttujan tyyppi elemType on samankaltainen kuin määritys ${tunnus:argType(viite,0)}, mutta erona on se, että se hakee myös arvotaulukon elementtilajin.

${array_type} on lyhyt muoto määrityksestä ${array_type:elemType(array)}.
${iterable_type} on lyhyt muoto määrityksestä ${iterable_type:elemType(iterable)}.

${id:newName(reference)} Arvoksi tulee ristiriidaton nimi uudelle paikallismuuttujalle, jonka tyypin viite määrittää. Viite voi olla joko Java-tyypin tai toisen mallipohjamuuttujan nimi. Luotu nimi on koodityyliasetusten mukainen.

${index} on lyhyt muoto määrityksestä ${index:newName(int)}.
${iterator} on lyhyt muoto määrityksestä ${iterator:newName(java.util.Iterator)}.
${array_element} on lyhyt muoto määrityksestä ${array_element:newName(array)}.
${iterable_element} on lyhyt muoto määrityksestä ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Hakee tyypin nimen täydellisen tarkennetun Java-tyypin nimen perusteella. Hakee yksinkertaisen tyypin nimen ja tuonnin, jos ristiriitaisia tyyppejä ei ole. Muussa tapauksessa hakee täydellisen tarkennetun tyypin nimen.

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

${:import(type[,type]*)} Lisää tuontilauseen kullekin tyypille. Jos tuonti on luotu aiemmin, ei tee mitään. Jos ristiriitainen tuonti on luotu aiemmin, ei tee mitään. Ei tuota arvoa.

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

${:importStatic([qualifiedName[,qualifiedName]*])} Lisää staattisen tuontilauseen kullekin tarkennetulle nimelle, jota ei ole vielä tuotu. qualifiedName on staattisen kentän tai metodin tarkennettu nimi tai se on tyypin tarkennettu nimi ja loppuliite .* puolilainausmerkkeihin '' laitettuna. Jos ristiriitainen tuonti on luotu aiemmin, ei tee mitään. Ei tuota arvoa.

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

${id:link(proposal[,proposal]*)} Hakee tunnuksen id, jos ehdotusluettelo on tyhjä. Muussa tapauksessa hakee ensimmäisen ehdotuksen. Arvioitu arvo siirtyy linkitettyyn tilaan. Kaikki annetut ehdotukset näkyvät ehdotusikkunassa.

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

${array} Arvoksi tulee käytössä olevassa laajuudessa näkyvissä oleva arvotaulukon ehdotus.
${array_element} Arvoksi tulee ${array}-muuttujan vastinarvon mukaisen elementin uuden paikallismuuttujan nimi.
${array_type} Arvoksi tulee ${array}-muuttujan vastinarvon elementtilaji.
${collection} Arvoksi tulee käytössä olevassa laajuudessa näkyvissä olevan kokoelman ehdotus.
${exception_variable_name} Poikkeusmuuttujan nimi catch-lohkoissa.
${index} Arvoksi tulee esittelemättömän arvotaulukkoindeksin ehdotus.
${iterator} Arvoksi tulee sellainen tyypin java.util.Iterator uuden paikallismuuttujan nimi, joka ei ole käytössä.
${iterable} Arvoksi tulee käytössä olevassa laajuudessa näkyvissä olevan iteroitavan objektin tai arvotaulukon ehdotus.
${iterable_element} Arvoksi tulee ${iterable}-muuttujan vastinarvon mukaisen elementin uuden paikallismuuttujan nimi.
${iterable_type} Arvoksi tulee ${iterable}-muuttujan vastinarvon elementtilaji.
${todo} Arvoksi tulee määritetyn oletustehtävätunnisteen ehdotus.

Aiheeseen liittyviä käsitteitä

Mallipohjat

Aiheeseen liittyviä ohjeita

Mallipohjien muokkaus
Mallipohjien oletusasetussivu
Java-sisällönhallinnan aputoiminto
Tehtävätunnisteiden oletusasetukset
Koodimallipohjien oletusasetukset
Koodityylin oletusasetukset