Java エディター・テンプレート変数

テンプレート変数は、テンプレート・パターンで使用されます。変数は、 テンプレートがそのコンテキストで評価される時に、具象値に解決されます。変数は、simple または full 構文を使用して指定できます。

変数に対して起こりうる一致がいくつかある場合は、ユーザーへのプロポーザルとして表示される場合があります。

一般テンプレート変数

Java コンテキストと Javadoc コンテキストの両方が以下の変数を定義します。

変数 説明
${cursor} テンプレート編集モードを離れるときのカーソル位置を指定します。 これは、テンプレート編集モードを離れるときに、テンプレートの終わりではなく、別の場所にカーソルをジャンプする場合に便利です。
${date} 評価の結果は、現在日付になります。
${dollar} 評価の結果は、ドル記号 $ になります。代わりに、2 つのドル記号 $$ を使用することができます。
${enclosing_method} 評価の結果は、エンクロージング・メソッドの名前になります。
${enclosing_method_arguments} 評価の結果は、エンクロージング・メソッドの引数名のコンマで区切られたリストになります。この変数は、多くのメソッドにログ・ステートメントを生成するときに役立ちます。
${enclosing_package} 評価の結果は、エンクロージング・パッケージの名前になります。
${enclosing_project} 評価の結果は、エンクロージング・プロジェクトの名前になります。
${enclosing_type} 評価の結果は、エンクロージング型名になります。
${file} 評価の結果は、ファイル名になります。
${line_selection} 評価の結果は、現在選択されているすべての行のコンテンツになります。
${primary_type_name} 評価の結果は、現行コンパイル単位の名前の 1 次型になります。
${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)} 参照されるテンプレート変数の nth 型の引数に評価されます。参照は他のテンプレート変数名となる必要があります。参照される変数が見つからない、またはパラメーター化された型でない場合、 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(java.util.List, java.util.Collection)}

${:importStatic([qualifiedName[,qualifiedName]*])} まだインポートされていない各修飾名の静的インポート・ステートメントを追加します。 qualifiedName は静的なフィールドまたはメソッドの完全修飾名、あるいは型の修飾名に接尾部 .* (単一引用符 '' で囲む) を付けたものです。 競合するインポートが存在する場合は、何も実行されません。 評価の結果はありません。

例:
${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 コンテンツ・アシスト
タスク・タグ設定
「コード・テンプレート」設定
「コード・スタイル」設定