Malvariabler for Java-redigeringsprogram

Malvariabler kan brukes i malmønsteret. Variabler peker på sin konkrete verdi når malen evalueres i sin kontekst. Variabler kan spesifiseres med enkel eller fullstendig syntaks:

Hvis det er flere mulige treff for en variabel, man de presenteres som forslag for brukeren.

Generelle malvariabler

Både Java- og Javadoc-konteksten definerer følgende variabler:

Variabel Beskrivelse
${cursor} Spesifiserer markørposisjonen idet malens redigeringsmodus forlates. Dette er nyttig om markøren skulle hoppe et annet sted enn til slutten av malen idet den forlater redigeringsmodus.
${date} Evaluerer til gjeldende dato.
${dollar} Evaluerer til dollartegnet $. Alternativt kan to dollartegn brukes: $$.
${enclosing_method} Evaluerer til navnet på innkapslende metode.
${enclosing_method_arguments} Evaluerer til en liste over argumentnavn på innkapsling metode (atskilt med kommaer). Denne variabelen kan være nyttig ved generering av loggsetninger for mange metoder.
${enclosing_package} Evaluerer til navnet på innkapslende pakke.
${enclosing_project} Evaluerer til navnet på innkapslende prosjekt.
${enclosing_type} Evaluerer til navnet på innkapslende type.
${file} Evaluerer til navnet på filen.
${line_selection} Evaluerer til innholdet i alle valgte linjer.
${primary_type_name} Evaluerer til primærtypenavnet til gjeldende kompileringsenhet.
${return_type} Evaluerer til returtypen til innkapslende metode.
${time} Evaluerer til gjeldende klokkeslett.
${user} Evaluerer til brukernavnet.
${word_selection} Evaluerer til innholdet i gjeldende tekstutvalg.
${year} Evaluerer til gjeldende år.

Java-spesifikke malvariabler

Java-konteksten definerer dessuten følgende variabler: Merk: I tabellen nedenfor er id et brukervalgt navn for en ny variabel.

Variabel Beskrivelse
${id:field(type[,type]*)} Evaluerer til et felt i gjeldende omfang som er en subtype under en av de gitte typene. Hvis ingen type oppgis, blir det samsvar for alle ikke-primitive felt.

Eksempel:
${count:field(int)}

${id:var(type[,type]*)} Evaluerer til et felt, en lokal variabel eller en parameter som er synlig i gjeldende omfang, og som er en subtype under en av de gitte typene. Hvis ingen type oppgis, blir det samsvar for alle ikke-primitive variabler.

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

${id:localVar(type[,type]*)} Evaluerer til en lokal variabel eller parameter som er synlig i gjeldende omfang, og som er en subtype under en av de gitte typene. Hvis ingen type oppgis, blir det samsvar for alle ikke-primitive lokale variabler.

${array} er en snarvei for ${array:localVar('java.lang.Object[]')}, men samsvarer også med matriser for primitive typer.
${collection} er en snarvei for ${collection:localVar(java.util.Collection)}.
${iterable} er en snarvei for ${iterable:localVar(java.lang.Iterable)}, men gir også treff på matriser.

${id:argType(variable, n)} Evaluerer til det nte typeargumentet i referert malvariabel. Referansen bør ha samme navn som en annen malvariabel. Peker på java.lang.Object hvis den refererte variabelen ikke blir funnet eller ikke er en parameterisert type.

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

${id:elemType(variable)} Evaluerer til elementtypen til den refererte malvariabelen. Referansen bør ha samme navn som en annen malvariabel som peker på en matrise eller forekomst av java.lang.Iterable. Variabeltypen elemType likner på ${id:argType(reference,0)}, men peker også på elementtypen til en matrise.

${array_type} er en snarvei for ${array_type:elemType(array)}.
${iterable_type} er en snarvei for ${iterable_type:elemType(iterable)}.

${id:newName(reference)} Evaluerer til et ikke-motstridende navn for en ny lokal variabel av typen angitt ved referansen. Referansen kan være et Java-typenavn eller navnet på en annen malvariabel. Det genererte navnet overholder kodestilinnstillingene.

${index} er en snarvei for ${index:newName(int)}.
${iterator} er en snarvei for ${iterator:newName(java.util.Iterator)}.
${array_element} er en snarvei for ${array_element:newName(array)}.
${iterable_element} er en snarvei for ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Evaluerer til et typenavn som er gitt det fullt kvalifiserte Java-typenavnet. Evaluerer til et enkelt typenavn og en import hvis det ikke finnes noen motstridende type. Evaluerer ellers til et fullt kvalifisert typenavn.

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

${:import(type[,type]*)} Legger til en importsetning for hver type. Gjør ingenting hvis importen allerede finnes. Gjør ingenting hvis det finnes en konfliktimport. Evaluerer til ingenting.

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

${:importStatic([qualifiedName[,qualifiedName]*])} Legger til en statisk import-setning for hvert kvalifiserte navn som ikke allerede er importert. qualifiedName er det fullt kvalifisert navnet på et statisk felt eller en metode, eller det er det fullt kvalifiserte navnet på en type pluss et .*-suffiks i enkeltanførselstegn ''. Gjør ingenting hvis det finnes en konfliktimport. Evaluerer til ingenting.

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

${id:link(proposal[,proposal]*)} Evaluerer til id hvis listen over forslag er tom, evaluerer ellers til det første forslaget. Den evaluerte verdien er lagt i linket modus. Et forslagsvindu viser alle de gitte forslagene.

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

${array} Evaluerer til et forslag for en matrise som er synlig i gjeldende omfang.
${array_element} Evaluerer til et navn for en ny lokal variabel for et element i variabelsamsvaret ${array}.
${array_type} Evaluerer til elementtypen til variabelsamsvaret ${array}.
${collection} Evaluerer til et forslag til samling som er synlig i gjeldende omfang.
${exception_variable_name} Navn på unntaksvariabel i catch-blokker.
${index} Evaluerer til et forslag til en udeklarert matriseindeks.
${iterator} Evaluerer til et ubrukt navn for en ny lokal variabel av typen java.util.Iterator.
${iterable} Evaluerer til et forslag til en itererbar eller matrise som er synlig i gjeldende omfang.
${iterable_element} Evaluerer til et navn for en ny lokal variabel for et element i variabelsamsvaret ${iterable}.
${iterable_type} Evaluerer til elementtypen til variabelsamsvaret ${iterable}.
${todo} Evaluerer til forslag til gjeldende spesifisert standard oppgavekode.

Beslektede begreper

Maler

Beslektet referanse

Redigere maler
Preferansesiden Maler
Java-innholdshjelp
Oppgavekodepreferanser
Kodemalpreferanser
Kodestilpreferanser