toString()-generator: Formatskabeloner

Formatskabeloner bruges af en enkel mekanisme, der giver mulighed for at ændre formatet på den genererede metodes outputstreng: begyndelse, afslutning, separator osv. De ligner JDT-kodeskabeloner, men de påvirker ikke den genererede kode direkte (Kodetyper bruges til dette). Her er en liste over tilgængelige skabelonvariabler:

${object.className}indsætter et klassenavn som en enkel streng
${object.getClassName}indsætter et kald til this.getClass.getName()
${object.superToString}indsætter et kald til super.toString()
${object.hashCode}indsætter et kald til this.hashCode()
${object.identityHashCode}indsætter et kald til System.identityHashCode(this)
${member.name}indsætter navnet på det første medlem
${member.name()}indsætter navnet på det første medlem, efterfulgt af parentes, hvis der er tale om metoder
${member.value}indsætter det første medlems værdi
${otherMembers}indsætter de resterende medlemmer. For hvert medlem evalueres skabelonfragmentet mellem første og sidste ${member.*}-variabel og tilføjes resultatet. Tegnene mellem sidste ${member.*} og ${otherMembers} definerer den separator, som indsættes mellem medlemmer (${otherMembers} skal placeres efter den sidste ${member.*}-variabel).

Hvis skabelonen skal fungere korrekt, skal ${otherMembers}-variablen bruges præcis én gang i skabelonen og kan ikke efterfølges af nogen ${member.*}-variabel. ${object.*}-variabler kan placeres andre steder i skabelonen, men hvis der placeres én i et medlemsrelateret fragment (dvs. mellem den første ${member.*}-variabel og ${otherMembers}), bliver den gentaget for hvert medlem, hvilket sandsynligvis ikke er en fornuftig løsning.

Beskrivelsen ovenfor kan måske virke kompliceret, men skabelonformatet selv er meget nemt at bruge. Det hele bør blive klart, når du har set nogle eksempler på anvendelsen.

Skabeloneksempler

  1. Standardskabelonen er et godt eksempel:

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

    Outputstrengen for denne skabelon ser sådan ud:

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. Output i flere linjer findes også:

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

    Eksempelresultat:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. Hvis du sætter et medlem i klammer, skal du huske at gøre det samme med ${otherMembers}-variablen:

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

    Sådan er virkningen:

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. ${object.*}-variabler kan bruges i begyndelsen og slutningen af skabelonen:

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

    Denne skabelon resulterer i et output som dette:

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

Relaterede referencer

Dialogboksen Generér toString()
toString()-generator: Kodetyper
toString()-generator: Indholdsliste