Gerador toString(): Modelos de Formato

Os modelos de formato são usados por um mecanismo simples que permite alterar o formato da cadeia de saída do método gerado: início, término, separador e assim por diante. Eles são semelhantes aos modelos do código JDT mas não afetam o código gerado diretamente (Estilos de Código são usados para isso). A seguir há uma lista das variáveis de modelo disponíveis:

${object.className}insere o nome de classe como uma Cadeia simples
${object.getClassName}insere uma chamada em this.getClass.getName()
${object.superToString}insere uma chamada em super.toString()
${object.hashCode}insere uma chamada em this.hashCode()
${object.identityHashCode}insere uma chamada em System.identityHashCode(this)
${member.name}insere o nome do primeiro membro
${member.name()}insere o nome do primeiro membro seguido por parênteses no caso de métodos
${member.value}insere o valor do primeiro membro
${otherMembers}insere os membros restantes. Para cada membro, o fragmento do modelo entre a primeira e a última variável ${member.*} é avaliado e anexado no resultado. Os caracteres entre o último ${member.*} e ${otherMembers} definem o separador que é inserido entre membros (${otherMembers} deve permanecer após a última variável ${member.*}).

Para o modelo funcionar corretamente, a variável ${otherMembers} deve ser usada exatamente uma vez em um modelo e não pode ser seguida por qualquer variável ${member.*}. As variáveis ${object.*} podem ser colocadas em qualquer lugar no modelo, contudo, se uma for colocada em um fragmento relacionado ao membro (ou seja, entre a primeira variável ${member.*} e ${otherMembers}), ela será repetida para cada membro, o que provavelmente não é uma solução sensata.

A descrição acima pode parecer complicada, mas o próprio formato do modelo é muito fácil de usar. Tudo deve se tornar claro após ver alguns exemplos de trabalho.

Exemplos de Modelo

  1. O modelo padrão é um bom exemplo:

    ${class.name} [${member.name()}=${member.value}, ${otherMembers}]

    A cadeia de saída para este modelo é semelhante ao seguinte:

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. A saída de múltiplas linhas também está disponível:

    ${object.getClassName} {
    	${member.name}: ${member.value}
    	${otherMembers}
    }

    Resultado de Exemplo:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. Se você colocar um membro entre chaves, não se esqueça de fazer o mesmo com a variável ${otherMembers}:

    {${member.name}=${member.value}},
    {${otherMembers}}

    A seguir há o efeito:

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. As variáveis ${object.*} podem ser usadas no início e no final do modelo:

    ${object.getClassName} (hashcode:${object.hashCode})
    	members: ${member.name} = ${member.value}; ${otherMembers}
    [super: ${object.superToString}]

    Este modelo resultaria em uma saída semelhante a esta:

    FooClass (hashCode:232198409832)
    	members: aFloat = 1.0; aString = hello; anInt = 10; anObject = null; aCharMethod = a
    [super: SuperFooClass[aField=null]]

Referência relacionada

Diálogo Gerar toString()
Gerador toString(): Estilos de Código
Gerador toString(): Listagem de Conteúdo