Generator metody toString(): szablony formatu

Szablony formatu są używane przez prosty mechanizm, który umożliwia zmianę formatu łańcucha wyjściowego wygenerowanej metody: może to być początek, zakończenie, separator itd. Szablony te przypominają szablony kodu JDT, ale nie wpływają bezpośrednio na wygenerowany kod (do tego celu używane są style kodu). Poniżej przedstawiono listę dostępnych zmiennych szablonu:

${object.className}Wstawia nazwę klasy jako prosty łańcuch.
${object.getClassName}Wstawia wywołanie metody this.getClass.getName().
${object.superToString}Wstawia wywołanie metody super.toString().
${object.hashCode}Wstawia wywołanie metody this.hashCode().
${object.identityHashCode}Wstawia wywołanie metody System.identityHashCode().
${member.name}Wstawia nazwę pierwszej składowej.
${member.name()}Wstawia nazwę pierwszej składowej (w przypadku metod po nazwie dodawane są nawiasy).
${member.value}Wstawia wartość pierwszej składowej.
${otherMembers}Wstawia pozostałe składowe. W przypadku każdej składowej fragment szablonu między pierwszą i ostatnią zmienną ${member.*} jest wartościowany i dodawany do wyniku. Znaki między ostatnią składową ${member.*} i składową ${otherMembers} definiują separator wstawiany między składowymi (zmienna ${otherMembers} musi znajdować się po ostatniej zmiennej ${member.*}).

Aby szablon działał poprawnie, zmienna ${otherMembers} musi zostać użyta dokładnie jeden raz w szablonie i nie mogą następować po niej żadne zmienne ${member.*}. Zmienne ${object.*} można umieścić w dowolnym miejscu szablonu, ale jeśli taka zmienna zostanie umieszczona we fragmencie związanym ze składową (tzn. między pierwszą zmienną ${member.*} a zmienną ${otherMembers}), zostanie powtórzona dla każdej składowej, co prawdopodobnie nie będzie dobrym rozwiązaniem.

Powyższy opis może wydawać się skomplikowany, ale użycie formatu szablonu jest bardzo proste. Powinno to stać się jasne po zapoznaniu się z kilkoma działającymi przykładami.

Przykłady szablonów

  1. Dobrym przykładem jest szablon domyślny:

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

    Łańcuch wynikowy dla tego szablonu ma następującą postać:

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. Możliwe są także wielowierszowe dane wyjściowe:

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

    Przykładowy wynik:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. Jeśli składowa zostanie umieszczona w nawiasach klamrowych, należy wykonać tę samą czynność dla zmiennej ${otherMembers}:

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

    Poniżej przedstawiono wynik:

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. Zmienne ${object.*} mogą być używane na początku i na końcu szablonu:

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

    Ten szablon spowoduje uzyskanie następujących danych wyjściowych:

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

Informacje pokrewne

Okno dialogowe Generowanie metody toString()
Generator metody toString(): style kodu
Generator metody toString(): lista zawartości