Java 編輯器範本變數

範本變數可使用於範本型樣中。在範本的環境定義中評估範本時,變數會解析為具體值。變數可使用 simple 或 full 語法加以指定:

如果變數有數個可能的相符項,可以用提議方式呈現給使用者。

一般範本變數

Java 和 Javadoc 環境定義皆會定義下列變數:

變數 說明
${cursor} 指出當離開範本編輯模式時的游標位置。 當您離開範本編輯模式時,如果您希望游標應移至另一位置,而非移至範本尾端,則可善用這項。
${date} 評估成現行日期。
${dollar} 評估成錢幣符號 $。另外,可使用兩個錢幣符號:$$。
${enclosing_method} 評估含括方法的名稱。
${enclosing_method_arguments} 評估成含括方法的以逗點區隔之引數名稱清單。這個變數有助於您為許多方法產生 log 陳述式。
${enclosing_package} 評估成含括套件的名稱。
${enclosing_project} 評估成含括專案的名稱。
${enclosing_type} 評估成含括類型的名稱。
${file} 評估成檔案的名稱。
${line_selection} 評估成目前選取的所有字行之內容。
${primary_type_name} 評估成現行編譯單元的名稱初始類型。
${return_type} 評估成含括方法的傳回類型。
${time} 評估成現行時間。
${user} 評估成使用者名稱。
${word_selection} 評估成現行文字選項的內容。
${year} 評估成現行年份。

Java 專用範本變數

Java 環境定義另外還定義下列變數。 附註:在下表中,id 是新變數的使用者選擇名稱。

變數 說明
${id:field(type[,type]*)} 評估為現行範圍中的欄位,其為任何給定類型的子類型。如果未指定類型,則任何非基本欄位都相符。

範例:
${count:field(int)}

${id:var(type[,type]*)} 評估為現行範圍中可見的欄位、區域變數或參數,其為任何給定類型的子類型。如果未指定類型,則任何非基本變數都相符。

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

${id:localVar(type[,type]*)} 評估為現行範圍中可見的區域變數或參數,其為任何給定類型的子類型。如果未指定類型,則任何非基本區域變數都相符。

${array} 是 ${array:localVar('java.lang.Object[]')} 的捷徑,但也符合初始類型的陣列。
${collection} 是 ${collection:localVar(java.util.Collection)} 的捷徑。
${iterable} 是 ${iterable:localVar(java.lang.Iterable)} 的捷徑,但也符合陣列。

${id:argType(variable, n)} 評估為參照的範本變數中的第 n 個類型引數。參照必須是另一個範本變數的名稱。如果參照的變數找不到或 不是參數化類型,則會解析成 java.lang.Object。

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

${id:elemType(variable)} 評估為參照的範本變數的元素類型。 此參照必須是另一個解析成陣列或 java.lang.Iterable 實例的範本變數名稱。 elemType 變數類型類似 ${id:argType(reference,0)},其差異在於它也會解析陣列的元素類型。

${array_type} 是 ${array_type:elemType(array)} 的捷徑。
${iterable_type} 是 ${iterable_type:elemType(iterable)} 的捷徑。

${id:newName(reference)} 評估為新區域變數的非衝突名稱,具有參照所指定的類型。參照可能是 Java 類型名稱或另一個範本變數的名稱。產生的名稱符合程式碼樣式設定。

${index} 是 ${index:newName(int)} 的捷徑。
${iterator} 是 ${iterator:newName(java.util.Iterator)} 的捷徑。
${array_element} 是 ${array_element:newName(array)} 的捷徑。
${iterable_element} 是 ${iterable_element:newName(iterable)} 的捷徑。

${id:newType(qualifiedTypeName)} 給定完整 Java 類型名稱,便評估為類型名稱。如果衝突類型不存在,便評估為簡式類型名稱和匯入。否則評估為完整的類型名稱。

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

${:import(type[,type]*)} 對於每一個類型各新增一個 import 陳述式。如果 import 已存在,則不執行任何動作。如果有衝突的匯入存在,不執行任何動作。不評估為任何東西。

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

${:importStatic([qualifiedName[,qualifiedName]*])} 對於每一個尚未匯入的完整名稱,各新增一個靜態的 import 陳述式。qualifiedName 是 static 欄位或方法的完整名稱,或是類型的完整名稱加上 .* 字尾並括上單引號 ''。如果有衝突的匯入存在,不執行任何動作。不評估為任何東西。

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

${id:link(proposal[,proposal]*)} 如果提議清單空白,便評估為 id,否則評估為第一個提議。評估值放到鏈結模式中。提議視窗會顯示所有給定的提議。

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

${array} 評估為現行範圍中可見陣列的提議。
${array_element} 評估為 ${array} 變數相符項的元素的新區域變數名稱。
${array_type} 評估為 ${array} 變數相符項的元素類型。
${collection} 評估為現行範圍中可見集合的提議。
${exception_variable_name} catch 區塊中的異常狀況變數名稱。
${index} 評估為未宣告之陣列索引的提議。
${iterator} 評估為 java.util.Iterator 類型的新區域變數的未用名稱。
${iterable} 評估為現行範圍中可見的可疊代項目或陣列的提議。
${iterable_element} 評估為 ${iterable} 變數相符項的元素的新區域變數名稱。
${iterable_type} 評估為 ${iterable} 變數相符項的元素類型。
${todo} 評估成目前指定之預設作業標籤的提議。

相關概念

範本

參考資訊

編輯範本
「範本」喜好設定頁面
Java 內容輔助
「作業標籤」喜好設定
「程式碼範本」喜好設定
「程式碼樣式」喜好設定