Java 编辑器模板变量

可以在模板模式中使用模板变量。在模板的上下文中对模板进行求值时,会将变量解析为具体的值。可以使用简单或完整语法来指定变量:

如果某个变量有多个可能的匹配项,那么可以将那些匹配项作为建议显示给用户。

常规模板变量

Java 和 Javadoc 上下文都定义了下列变量:

变量 描述
${cursor} 指定离开模板编辑方式时的光标位置。如果离开模板编辑方式时光标应该跳到另一位置而不是模板末尾,那么此变量很有用。
${date} 求值为当前日期。
${dollar} 求值为美元符号 $。也可以使用两个美元符号:$$。
${enclosing_method} 求值为外层方法的名称。
${enclosing_method_arguments} 求值为外层方法的以逗号分隔的参数名列表。在为许多方法生成日志语句时,此变量很有用。
${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)} 求值为 reference 所指定类型的新局部变量的非冲突名称。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 是静态字段或方法的标准名称,或者它是类型的限定名,并以括在单引号 '' 中的 .* 作为后缀。 如果导入时发生冲突,那么不执行任何操作。不求值为任何内容。

示例:
${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 内容辅助
任务标记首选项
代码模板首选项
代码样式首选项