toString() előállító: Formátumsablonok

A formátumsablonokat egy egyszerű mechanizmus használja, melynek segítségével módosíthatja az előállított metódus kimeneti karaktersorozatának formátumát: az elejét, a végét, az elválasztókat, és így tovább. Ezek hasonlók a JDT kódsablonokhoz, de nem közvetlenül vannak hatással az előállított kódra (ahhoz a Kódstílusok használhatók). Íme az elérhető sablonváltozók listája:

${object.className}egyszerű karaktersorozatként szúrja be az osztálynevet
${object.getClassName}beszúr egy this.getClass.getName() hívást
${object.superToString}beszúr egy super.toString() hívást
${object.hashCode}beszúr egy this.hashCode() hívást
${object.identityHashCode}beszúr egy System.identityHashCode(this) hívást
${member.name}beszúrja az első tag nevét
${member.name()}beszúrja az első tag nevét, amelyet metódusok esetén egy zárójelpár követ
${member.value}beszúrja az első tag értékét
${otherMembers}beszúrja a fennmaradó tagokat Minden tag esetén a rendszer kiértékeli az első és az utolsó ${member.*} változó között sablontöredéket és hozzáfűzi az eredményt. Az utolsó ${member.*} és az ${otherMembers} közti karakterek határozzák meg a tagok közé beszúrt elválasztót (az ${otherMembers} változónak az utolsó ${member.*} változó után kell állnia).

A sablon megfelelő működése érdekében az ${otherMembers} változót pontosan egyszer kell használni a sablonban, és nem következhet utána semmilyen ${member.*} változó. Az ${object.*} változók bárhová helyezhetők a sablonban, habár ha az egyik egy tagra vonatkozó sablonba kerül (azaz az első ${member.*} változó és az ${otherMembers} változó közé), akkor minden tag esetén megismétlődi, ami valószínűleg nem egy átgondolt megoldás.

A fenti leírás bonyolultnak tűnhet, de magát a sablonformátumot nagyon könnyű használni. Ez néhány működő példa bemutatása után teljesen világossá válik.

Sablon példák

  1. Az alapértelmezett sablon egy jó példa:

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

    A sablon kimeneti karaktersorozata a következő lesz:

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. Többsoros kimenet is elérhető:

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

    Példa eredmény:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. Ha egy tagot kapcsos zárójelek közé zár, akkor jusson eszébe megtenni ugyanezt az ${otherMembers} változóval is:

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

    Íme a hatás:

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. Az ${object.*} változók a sablon elején és végén használhatók:

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

    Ez a sablon a következőhöz hasonló kimenetet eredményez:

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

Kapcsolódó leírások

toString() előállítása párbeszédablak
toString() előállító: Kódstílusok
toString() előállító: Tartalom felsorolása