Zmienne szablonu edytora Java

Zmiennych szablonu można używać we wzorcu szablonu. W momencie rozstrzygania szablonu w kontekście zmiennych w ich miejsce są wstawiane konkretne wartości. Zmienne można określić, używając składni prostej lub pełnej:

Jeśli istnieje więcej możliwych dopasowań zmiennej, informacje o nich zostaną przedstawione użytkownikowi.

Ogólne zmienne szablonu

W środowisku Java i dokumentacji Javadoc są zdefiniowane następujące zmienne:

Zmienna Opis
${cursor} Pozwala określić pozycję kursora w momencie wyjścia z trybu edycji szablonu. Przydaje się to w sytuacji, jeśli w momencie wyjścia z trybu edycji szablonu kursor miałby przeskoczyć w miejsce inne niż koniec szablonu.
${date} Zmienna przyjmuje wartość bieżącej daty.
${dollar} Wartościowana do symbolu dolara $. Alternatywnie można użyć dwóch znaków dolara: $$.
${enclosing_method} Zmienna przyjmuje wartość nazwy metody obejmującej.
${enclosing_method_arguments} Zmienna przyjmuje wartość oddzielanej przecinkami listy nazw argumentów metody obejmującej. Zmienna ta może być przydatna podczas generowania instrukcji rejestrowania dla wielu metod.
${enclosing_package} Zmienna przyjmuje wartość nazwy pakietu obejmującego.
${enclosing_project} Zmienna przyjmuje wartość nazwy projektu obejmującego.
${enclosing_type} Zmienna przyjmuje wartość nazwy typu obejmującego.
${file} Zmienna przyjmuje wartość nazwy pliku.
${line_selection} Zmienna przyjmuje wartość treści wszystkich wybranych wierszy.
${primary_type_name} Zmienna przyjmuje wartość nazwy podstawowego typu bieżącej jednostki kompilacji.
${return_type} Zmienna przyjmuje wartość typu zwracanej wartości metody obejmującej.
${time} Zmienna przyjmuje wartość bieżącej godziny.
${user} Zmienna przyjmuje wartość nazwy użytkownika.
${word_selection} Zmienna przyjmuje wartość treści wybranego tekstu.
${year} Zmienna przyjmuje wartość bieżącego roku.

Zmienne szablonu specyficzne dla języka Java

W kontekście Java są dodatkowo definiowane poniżej wymienione zmienne. Uwaga: W poniższej tabeli id oznacza wybraną przez użytkownika nazwę nowej zmiennej.

Zmienna Opis
${id:field(type[,type]*)} Zmienna przyjmuje wartość pola w bieżącym zasięgu - podtypu dowolnych podanych typów. Jeśli nie zostanie podany żaden typ, pasujące jest dowolne niepodstawowe pole.

Przykład:
${count:field(int)}

${id:var(type[,type]*)} Zmienna przyjmuje wartość pola, zmiennej lokalnej lub parametru widocznego w bieżącym zasięgu - podtypu dowolnych podanych typów. Jeśli nie zostanie podany żaden typ, pasująca jest dowolna niepodstawowa zmienna.

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

${id:localVar(type[,type]*)} Zmienna przyjmuje wartość zmiennej lokalnej lub parametru widocznego w bieżącym zasięgu - podtypu dowolnych podanych typów. Jeśli nie zostanie podany żaden typ, pasująca jest dowolna niepodstawowa zmienna lokalna.

Zmienna ${array} to skrót zapisu ${array:localVar('java.lang.Object[]')}, ale jest ona również zgodna z tablicami o typach podstawowych.
${collection} jest skróconą formą zmiennej ${collection:localVar(java.util.Collection)}.
${iterable} jest skróconą formą zmiennej ${iterable:localVar(java.lang.Iterable)}, pasuje również do tablic.

${id:argType(zmienna, n)} Zmienna przyjmuje wartość n-tego argumentu typu zmiennej szablonu, do której jest odniesienie. Odniesienie powinno być nazwą innej zmiennej szablonu. Jest rozstrzygane jako java.lang.Object, jeśli dana zmienna nie zostanie znaleziona lub nie jest typem sparametryzowanym.

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

${id:elemType(variable)} Zmienna przyjmuje wartość typu elementu zmiennej szablonu, do której jest odniesienie. Odniesienie powinno być nazwą innej zmiennej szablonu, rozstrzyganej jako tablica lub instancja java.lang.Iterable. Typ zmiennej elemType jest zbliżony do ${id:argType(reference,0)}, różni się tym, że rozstrzyga również typ elementu tablicy.

${array_type} jest skróconą formą zmiennej ${array_type:elemType(array)}.
${iterable_type} jest skróconą formą zmiennej ${iterable_type:elemType(iterable)}.

${id:newName(reference)} Zmienna przyjmuje wartość niepowodującej konfliktów nazwy nowej zmiennej lokalnej typu określonego przez odniesienie. Odniesienie może być nazwą typu języka Java lub nazwą innej zmiennej szablonu. Wygenerowana nazwa powinna być zgodna z ustawieniami stylu kodowania.

${index} jest skróconą formą zmiennej ${index:newName(int)}.
${iterator} jest skróconą formą zmiennej ${iterator:newName(java.util.Iterator)}.
${array_element} jest skróconą formą zmiennej ${array_element:newName(array)}.
${iterable_element} jest skróconą formą zmiennej ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Wartościowanie do nazwy typu i podanie pełnej nazwy typu Java. Jeśli nie istnieje żaden typ powodujący konflikt, wartościowanie do typu prostego i instrukcji importu. W przeciwnym razie wartościowanie do pełnej nazwy typu.

Przykład:
${type:newType(java.util.Iterator)}

${:import(type[,type]*)} Dodaje instrukcję importu dla każdego typu. Nie powoduje żadnego działania, jeśli instrukcja importu już istnieje. Nie powoduje żadnego działania, jeśli istnieje konflikt instrukcji importu. Wartościowanie do wartości pustej.

Przykład:
${:import(java.util.List, java.util.Collection)}

${:importStatic([qualifiedName[,qualifiedName]*])} Dodaje statyczną instrukcję importu dla każdej nazwy kwalifikowanej, która nie jest jeszcze zaimportowana. Nazwa qualifiedName to pełna nazwa statycznego pola lub statycznej metody albo pełna nazwa typu z przyrostkiem .* i jest ona objęta znakami pojedynczego cudzysłowu ''. Nie powoduje żadnego działania, jeśli istnieje konflikt instrukcji importu. Wartościowanie do wartości pustej.

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

${id:link(proposal[,proposal]*)} Wartościowanie do wartości id, jeśli lista propozycji jest pusta. W przeciwnym razie wartościowanie do pierwszej propozycji. Wartościowana wartość jest przełączana w tryb dowiązany. W oknie propozycji wyświetlane są wszystkie dane propozycje.

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

${array} Zmienna przyjmuje wartość propozycji tablicy widocznej w bieżącym zasięgu.
${array_element} Zmienna przyjmuje wartość nazwy nowej zmiennej lokalnej elementu dopasowanej zmiennej ${array}.
${array_type} Zmienna przyjmuje wartość typu elementu dopasowanej zmiennej ${array}.
${collection} Zmienna przyjmuje wartość propozycji kolekcji widocznej w bieżącym zasięgu.
${exception_variable_name} Nazwa zmiennej wyjątku w blokach catch.
${index} Zmienna przyjmuje wartość propozycji niezadeklarowanego indeksu tablicy.
${iterator} Zmienna przyjmuje wartość nieużywanej nazwy nowej zmiennej lokalnej typu java.util.Iterator.
${iterable} Zmienna przyjmuje wartość propozycji obiektu iterowalnego lub tablicy widocznej w bieżącym zasięgu.
${iterable_element} Zmienna przyjmuje wartość nazwy nowej zmiennej lokalnej elementu dopasowanej zmiennej ${iterable}.
${iterable_type} Zmienna przyjmuje wartość typu elementu dopasowanej zmiennej ${iterable}.
${todo} Zmienna przyjmuje wartość propozycji aktualnie podanego domyślnego znacznika zadania.

Pojęcia pokrewne

Szablony

Informacje pokrewne

Edycja szablonów
Strona preferencji szablonów
Aktywna obsługa treści Java
Preferencje znaczników zadań
Preferencje szablonów kodu
Preferencje stylu kodu