Variables de plantilla Editor Java

Las variables de plantilla pueden utilizarse en el patrón de plantilla. Las variables se resuelven en su valor concreto cuando la plantilla se evalúa en el contexto correspondiente. Las variables pueden especificarse mediante la sintaxis simple o completa:

Si hay varias coincidencias posibles para una variable, estas pueden presentarse como proposiciones al usuario.

Variables de plantilla generales

Tanto en el contexto Java como en el contexto Javadoc, se definen las siguientes variables:

Variable Descripción
${cursor} Especifica la posición del cursor cuando se sale de la modalidad de edición de la plantilla. Resulta de utilidad cuando el cursor debe saltar a otro lugar que no es el final de la plantilla al salir de la modalidad de edición de la plantilla.
${date} Da como resultado la fecha actual.
${dollar} Da como resultado el símbolo del dólar $. Existe la posibilidad de utilizar dos símbolos del dólar: $$.
${enclosing_method} Da como resultado el nombre del método delimitador.
${enclosing_method_arguments} Da como resultado una lista de nombres de argumentos (separados por una coma) del método delimitador. Esta variable puede ser de utilidad al generar sentencias de anotaciones (log) para muchos métodos.
${enclosing_package} Da como resultado el nombre del paquete delimitador.
${enclosing_project} Da como resultado el nombre del proyecto delimitador.
${enclosing_type} Da como resultado el nombre del tipo delimitador.
${file} Da como resultado el nombre del archivo.
${line_selection} Da como resultado el contenido de todas las líneas seleccionadas actualmente.
${primary_type_name} Da como resultado el nombre de tipo primario de la unidad de compilación actual.
${return_type} Da como resultado el tipo de retorno del método delimitador.
${time} Da como resultado la hora actual.
${user} Da como resultado el nombre del usuario.
${word_selection} Da como resultado el contenido de la selección de texto actual.
${year} Da como resultado el año actual.

Variables de plantilla específicas de Java

El contexto Java define adicionalmente las variables siguientes. Nota: en la tabla siguiente id es un nombre elegido por el usuario de una variable nueva.

Variable Descripción
${id:field(type[,type]*)} Da como resultado un campo del ámbito actual que es un subtipo de cualquiera de los tipos dados. Si no se especifica ningún tipo, coincide cualquier campo no primitivo.

Ejemplo:
${count:field(int)}

${id:var(type[,type]*)} Da como resultado un campo, variable local o parámetro visible en el ámbito actual que es un subtipo de cualquiera de los tipos dados. Si no se especifica ningún tipo, coincide cualquier variable no primitiva.

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

${id:localVar(type[,type]*)} Da como resultado una variable local o parámetro visible en el ámbito actual que es un subtipo de cualquiera de los tipos dados. Si no se especifica ningún tipo, coincide cualquier variable local no primitiva.

${array} es un atajo para ${array:localVar('java.lang.Object[]')} pero también coincide con matrices de tipos primitivos.
${collection} es un atajo para ${collection:localVar(java.util.Collection)}.
${iterable} es un atajo para ${iterable:localVar(java.lang.Iterable)} pero también coincide con matrices.

${id:argType(variable, n)} Da como resultado el enésimo tipo de argumento de la variable de plantilla a la que se hace referencia. La referencia debe ser el nombre de otra variable de plantilla. Se resuelve en java.lang.Object si la variable a la que se hace referencia no puede encontrarse o no es un tipo parametrizado.

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

${id:elemType(variable)} Da como resultado el tipo de elemento de la variable de plantilla a la que se hace referencia. La referencia debe ser el nombre de otra variable de plantilla que se resuelve en una matriz o una instancia de java.lang.Iterable. El tipo de variable elemType es parecido a ${id:argType(reference,0)}, con la diferencia de que también resuelve el tipo de elemento de una matriz.

${array_type} es un atajo para ${array_type:elemType(array)}.
${iterable_type} es un atajo para ${iterable_type:elemType(iterable)}.

${id:newName(reference)} Da como resultado un nombre no conflictivo, para una variable local nueva del tipo especificado por la referencia. La referencia puede ser un nombre de tipo Java o el nombre de otra variable de plantilla. El nombre generado respeta los valores de estilo de código.

${index} es un atajo para ${index:newName(int)}.
${iterator} es un atajo para ${iterator:newName(java.util.Iterator)}.
${array_element} es un atajo para ${array_element:newName(array)}.
${iterable_element} es un atajo para ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Evalúa para un nombre de tipo dado el nombre de tipo Java totalmente calificado. Evalúa para un nombre de tipo simple y una importación si no hay tipos en conflicto. De lo contrario evalúa para un nombre de tipo totalmente calificado.

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

${:import(type[,type]*)} Añade una sentencia de importación para cada tipo. No hace nada si la importación ya existe. No hace nada si hay una importación conflictiva. No evalúa para nada.

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

${:importStatic([qualifiedName[,qualifiedName]*])} Añade una sentencia de importación estática para cada nombre calificado que no se ha importado ya. qualifiedName es el nombre totalmente calificado de un campo o método estático o es el nombre calificado de un tipo más un sufijo .*, delimitado entre comillas simples ''. No hace nada si hay una importación conflictiva. No evalúa para nada.

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

${id:link(proposal[,proposal]*)} Evalúa para id si la lista de proposiciones está vacía, de lo contrario evalúa para la primera proposición. El valor evaluado se pone en modalidad enlazada. Una ventana de proposición muestra todas las proposiciones dadas.

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

${array} Da como resultado una propuesta para una matriz visible en el ámbito actual.
${array_element} Da como resultado un nombre para una variable local para un elemento de la coincidencia de variable ${array}.
${array_type} Da como resultado el tipo de elemento de la coincidencia de variable ${array}.
${collection} Da como resultado una propuesta para una recopilación visible en el ámbito actual.
${exception_variable_name} Nombre de variable de excepción en bloques catch.
${index} Da como resultado una propuesta para el índice de una matriz no declarada.
${iterator} Da como resultado un nombre no utilizado para una variable local nueva de tipo java.util.Iterator.
${iterable} Da como resultado una propuesta para un iterable o una matriz visible en el ámbito actual.
${iterable_element} Da como resultado un nombre para una variable local para un elemento de la coincidencia de variable ${iterable}.
${iterable_type} Da como resultado el tipo de elemento de la coincidencia de variable ${iterable}.
${todo} Da como resultado una propuesta para el código de tarea predeterminado especificado actualmente.

Conceptos relacionados

Plantillas

Consulta relacionada

Editar plantillas
Página de preferencias de plantilla
Asistencia de contenido Java
Preferencias de códigos de tarea
Preferencias de plantillas de código
Preferencias de estilo de código