Variáveis de Modelo do Editor Java

As variáveis de modelo podem ser usadas no padrão de modelo. As variáveis são processadas no valor concreto quando o modelo é avaliado no respectivo contexto. As variáveis podem ser especificadas usando uma sintaxe simples ou completa:

Se existirem várias correspondências possíveis para uma variável, podem ser apresentadas como propostas para o utilizador.

Variáveis Gerais de Modelo

O contexto Java e de Javadoc definem as seguintes variáveis:

Variável Descrição
${cursor} Especifica a posição do cursor quando é abandonado o modo de edição do modelo. Isto é útil quando o cursor deveria saltar para outro local que não seja o final do modelo ao abandonar o modo de edição do modelo.
${date} Avalia a data actual.
${dollar} Avalia para o símbolo de dólar $. Alternativamente, podem ser utilizados dois símbolos de dólar: $$.
${enclosing_method} Avalia para o nome do método delimitador.
${enclosing_method_arguments} Avalia uma lista separada por vírgulas de nomes de argumentos do método delimitador. Esta variável pode ser útil quando gerar instruções de registo para muitos métodos.
${enclosing_package} Avalia o nome do pacote delimitador.
${enclosing_project} Avalia o nome do projecto delimitador.
${enclosing_type} Avalia o nome do tipo delimitador.
${file} Avalia o nome do ficheiro.
${line_selection} Avalia o conteúdo de todas as linhas seleccionadas actualmente.
${primary_type_name} Avalia o tipo principal de nome da unidade de compilação actual.
${return_type} Avalia o tipo de retorno do método delimitador.
${time} Avalia a hora actual.
${user} Avalia o nome de utilizador.
${word_selection} Avalia o conteúdo da selecção de texto actual.
${year} Avalia o ano actual.

Variáveis de Modelo Específicas de Java

O contexto Java define adicionalmente as seguintes variáveis. Nota: Na tabela abaixo, o id é um nome escolhido pelo utilizador de uma nova variável.

Variável Descrição
${id:field(type[,type]*)} Avalia um campo no âmbito actual que é um subtipo dos tipos indicados. Caso não seja especificado qualquer tipo, é feita a correspondência a qualquer campo que não seja primitivo.

Exemplo:
${count:field(int)}

${id:var(type[,type]*)} Avalia um campo, variável local ou parâmetro visível no âmbito actual que é um subtipo de qualquer dos tipos indicados. Caso não seja especificado qualquer tipo, é feita a correspondência a qualquer variável que não seja primitiva.

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

${id:localVar(type[,type]*)} Avalia uma variável local ou parâmetro visível no âmbito actual que é um subtipo de qualquer dos tipos indicados. Se não for especificado qualquer tipo, é feita a correspondência a qualquer variável local que não seja primitiva.

${array} é um atalho para ${array:localVar('java.lang.Object[]')}, mas também corresponde a matrizes de tipos primitivos.
${collection} é um atalho para ${collection:localVar(java.util.Collection)}.
${iterable} é um atalho para ${iterable:localVar(java.lang.Iterable)}, mas também corresponde a matrizes.

${id:argType(variable, n)} Avalia o argumento de tipo nth da variável de modelo referenciada. A referência deverá ser o nome de outra variável de modelo. Processa para java.lang.Object se não for possível encontrar a variável referenciada ou se não for um tipo parametrizado.

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

${id:elemType(variable)} Avalia o tipo de elemento da variável de modelo referenciada. A referência deve ser o nome de outra variável de modelo que processa para uma matriz ou para uma instância de java.lang.Iterable. O tipo de variável elemType é semelhante a ${id:argType(reference,0)}, diferenciando-se por também processar o tipo de elemento de uma matriz.

${array_type} é um atalho para${array_type:elemType(array)}.
${iterable_type} é um atalho para${iterable_type:elemType(iterable)}.

${id:newName(reference)} Avalia um nome que não entre em conflito para uma nova variável local do tipo especificado pela referência. A referência pode ser um tipo de nome Java ou o nome de outra variável de modelo. O nome criado respeita as definições de estilo de código.

${index} é um atalho para${index:newName(int)}.
${iterator} é um atalho para${iterator:newName(java.util.Iterator)}.
${array_element} é um atalho para ${array_element:newName(array)}.
${iterable_element} é um atalho para ${iterable_element:newName(iterable)}.

${id:newType(qualifiedTypeName)} Avalia um nome de tipo a que foi dado o nome de tipo Java completo. Avalia um nome de tipo simples e uma importação caso não exista qualquer tipo em conflito. Caso contrário, avalia um nome de tipo completo.

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

${:import(type[,type]*)} Adiciona uma instrução de importação para cada tipo. Não realiza qualquer acção se a importação já existir. Não realiza qualquer acção se existir uma importação em conflito. Não faz qualquer avaliação.

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

${:importStatic([qualifiedName[,qualifiedName]*])} Adiciona uma instrução de importação estática para cada nome qualificado que ainda não tiver sido importado. O qualifiedName é um nome completamente qualificado de um campo ou método estático ou é o nome qualificado de um tipo mais um sufixo .*, delimitado por aspas simples ''. Não realiza qualquer acção se existir uma importação em conflito. Não faz qualquer avaliação.

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

${id:link(proposal[,proposal]*)} Avalia como id se a lista de propostas estiver vazia, caso contrário avalia como primeira proposta. O valor avaliado é colocado em modo ligado. Uma janela de proposta mostra todas as propostas dadas.

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

${array} Avalia uma proposta de matriz visível no âmbito actual.
${array_element} Avalia um nome de uma nova variável local de um elemento da correspondência da variável ${array}.
${array_type} Avalia o tipo de elemento da correspondência da variável ${array}.
${collection} Avalia uma proposta de uma recolha visível no âmbito actual.
${exception_variable_name} Nome da variável de excepção em blocos catch.
${index} Avalia uma proposta para um índice de matriz não declarada.
${iterator} Avalia um nome que não é usado para uma nova variável local do tipo java.util.Iterator.
${iterable} Avalia uma proposta de um iterável ou de uma matriz visível no âmbito actual.
${iterable_element} Avalia um nome de uma nova variável local de um elemento da correspondência da variável ${iterable}.
${iterable_type} Avalia o tipo de elemento da correspondência da variável ${iterable}.
${todo} Avalia uma proposta de um identificador de tarefas predefinido especificado actualmente.

Conceitos relacionados

Modelos

Referência relacionada

Editar Modelos
Página Preferências dos Modelos
Assistência a conteúdos Java
Preferências do identificador de tarefas
Preferências dos modelos de código
Preferências de estilo de código