Gerador toString(): Modelos de formatos

Os modelos de formatos são utilizados por um mecanismo simples que permite que o utilizador altere o formato de uma cadeia de saída de dados do método gerado: o princípio, o final, o separador, etc. Os modelos de formatos são semelhantes aos modelos de código JDT, mas não afectam directamente o código gerado (são utilizados Estilos de código para esse efeito). Segue-se uma lista das variáveis de modelos disponíveis:

${object.className}insere o nome de classe como uma cadeia simples
${object.getClassName}insere uma chamada de this.getClass.getName()
${object.superToString}insere uma chamada de super.toString()
${object.hashCode}insere uma chamada de this.hashCode()
${object.identityHashCode}insere uma chamada de System.identityHashCode(this)
${member.name}insere o nome do primeiro membro
${member.name()}insere o nome do primeiro membro seguido de parêntesis caso se tratar de um método
${member.value}insere o valor do primeiro membro
${otherMembers}insere os restantes membros. Para cada membro, o fragmento do modelo entre a primeira e a última variável ${member.*} é avaliado e anexado ao resultado. Os caracteres entre o último ${member.*} e ${otherMembers} definem o separador inserido entre os membros (${otherMembers} tem de ficar depois da última variável ${member.*}).

Para que o modelo funcione correctamente, a variável ${otherMembers} tem de ser utilizada exactamente uma vez num modelo e não pode ser seguida de nenhuma variável ${member.*}. As variáveis ${object.*} podem ser colocadas em qualquer parte do modelo embora se uma for colocada num fragmento relacionado com um membro (isto é, entre a primeira variável ${member.*} e ${otherMembers}), será repetida em todos os membros, o que possivelmente não é uma solução razoável.

A descrição acima poderá parecer complicada, mas o formato de modelo em si é muito fácil de utilizar. Tudo deverá parecer mais claro depois de ter visto alguns exemplos de como funciona.

Exemplos de modelos

  1. O modelo predefinido é um bom exemplo:

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

    A cadeia de saída de dados deste modelo é semelhante à seguinte:

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. Está igualmente disponível uma saída de dados com várias linhas:

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

    Resultado de exemplo:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. Se delimitar um membro entre parêntesis, lembre-se de fazer o mesmo com a variável ${otherMembers}:

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

    Este é o efeito produzido:

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

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

    Este modelo irá ter como resultado uma saída de dados semelhante à seguinte:

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

Referência relacionada

Caixa de diálogo Gerar to(String)
Gerador toString(): Estilos de código
Gerador toString(): Conteúdos de listas