Variáveis de Modelo do Editor Java

As variáveis de modelo podem ser utilizadas no padrão do modelo. As variáveis são resolvidas para seus valores concretos quando o modelo é avaliado em seu contexto. As variáveis podem ser especificadas utilizando sintaxe simples ou completa:

Se houver várias correspondências possíveis para uma variável, elas poderão ser apresentadas como propostas para o usuário.

Variáveis de Modelo Gerais

Ambos os contextos, Java e Javadoc, definem as seguintes variáveis:

Variável Descrição
${cursor} Especifica a posição do cursor quando este deixa o modo de edição do modelo. Isto é útil quando o cursor tem que pular para outro local, que não o fim do modelo ao deixar o modo de edição do modelo.
${date} Determina a data atual.
${dollar} Resulta no símbolo de dólar $. Como alternativa, dois símbolos de dólar podem ser usados: $$.
${enclosing_method} Resulta no nome do método de fechamento.
${enclosing_method_arguments} Resulta em uma lista, separada por vírgulas, de nomes de argumentos do método de inclusão. Esta variável pode ser útil na geração de instruções de log para vários métodos.
${enclosing_package} Resulta no nome do pacote de inclusão.
${enclosing_project} Resulta no nome do projeto de inclusão.
${enclosing_type} Resulta no nome do tipo de inclusão.
${file} Resulta no nome do arquivo.
${line_selection} Avalia o conteúdo de todas as linhas selecionadas atualmente.
${primary_type_name} Resulta no tipo primário do nome da unidade de compilação atual.
${return_type} Resulta no tipo de retorno do método de inclusão.
${time} Resulta no horário atual.
${user} Resulta no nome de usuário.
${word_selection} Resulta no conteúdo da seleção de texto atual.
${year} Resulta no ano atual.

Variáveis de Modelo Específicas do Java

O contexto Java também define as seguintes variáveis. Nota: Na tabela a seguir, id é um nome escolhido pelo usuário de uma nova variável.

Variável Descrição
${id:field(type[,type]*)} Avaliado para um campo no escopo atual, que é um subtipo de qualquer um dos tipos fornecidos. Se nenhum tipo for especificado, qualquer campo não primitivo será correspondido.

Exemplo:
${count:field(int)}

${id:var(type[,type]*)} Avaliado para um campo, variável local ou parâmetro visível no escopo atual, que é um subtipo de qualquer um dos tipos fornecidos. Se nenhum tipo for especificado, qualquer variável não primitiva será correspondida.

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

${id:localVar(type[,type]*)} Avaliado para uma variável local ou parâmetro visível no escopo atual, que é um subtipo de qualquer um dos tipos fornecidos. Se nenhum tipo for especificado, qualquer variável local não primitiva será correspondida.

${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 para o n argumento de tipo da variável referenciada no modelo. A referência deve ser o nome de outra variável do modelo. Resolverá para java.lang.Object se a variável referenciada não puder ser localizada ou 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 para o tipo de elemento da variável referenciada no modelo. A referência deve ser o nome de outra variável do modelo que resolva para uma matriz ou uma instância de java.lang.Iterable. O tipo de variável elemType é similar a ${id:argType(reference,0)}, a diferença também resolve 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 para um nome não conflitante de uma nova variável local do tipo especificado pela referência. A referência pode ser um nome de tipo Java ou o nome de outra variável do modelo. O nome gerado segue as configuraçõ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)} Avaliado para um nome de tipo, dado o nome de tipo Java completo. Avalia para um nome de tipo simples e uma importação, se não houver nenhum conflito de tipo. Caso contrário, avaliará para um nome completo de tipo.

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

${:import(type[,type]*)} Inclui uma instrução de importação para cada tipo. Não acontecerá nada se a importação já existir. Nada será executado se houver um conflito de importação. Avaliado para nada.

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

${:importStatic([qualifiedName[,qualifiedName]*])} Inclui uma instrução de importação estática para cada nome qualificado ainda não importado. O qualifiedName é o nome completo de um campo ou método estático ou é o nome qualificado de um tipo mais um sufixo .*, colocado entre aspas simples ''. Nada será executado se houver um conflito de importação. Avaliado para nada.

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

${id:link(proposal[,proposal]*)} Avaliado para id se a lista de propostas estiver vazia, caso contrário, será avaliado para a primeira proposta. O valor avaliado é colocado no modo vinculado. Uma janela de propostas mostra todas as propostas fornecidas.

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

${array} Avalia para uma proposta de uma matriz visível no escopo atual.
${array_element} Avalia para um nome de uma variável local para um elemento da correspondência da variável ${array}.
${array_type} Avalia para o tipo de elemento da correspondência da variável ${array}.
${collection} Avalia para uma proposta de uma coleta visível no escopo atual.
${exception_variable_name} Nome da variável de exceção em blocos de captura.
${index} Avalia para uma proposta de um índice de matriz não declarado.
${iterator} Avalia para um nome não utilizado de uma nova variável local do tipo java.util.Iterator.
${iterable} Avalia para uma proposta de uma variável que pode ser iterada ou uma matriz visível no escopo atual.
${iterable_element} Avalia para um nome de uma variável local para um elemento da correspondência da variável ${iterable}.
${iterable_type} Avalia para o tipo de elemento da correspondência da variável ${iterable}.
${todo} Resulta em uma proposta para a tag da tarefa padrão especificada atualmente.

Conceitos relacionados

Modelos

Referência relacionada

Modelos de Edição
Página de Preferências Modelos
Assistente de Conteúdo Java
Preferências da Tag de Tarefa
Preferências de Modelos de Código
Preferências de Estilo de Código