toString() 生成プログラム: フォーマット・テンプレート

フォーマット・テンプレートは、生成されたメソッドの出力ストリングのフォーマット (開始、終了、セパレーターなど) を変更できる単純なメカニズムによって使用されます。これは JDT コード・テンプレートに似ていますが、 生成されたコードに直接影響することはありません (コード・スタイルがそのために使用されます)。使用可能なテンプレート変数のリストは以下のとおりです。

${object.className}クラス名を単純な String として挿入します
${object.getClassName}this.getClass.getName() の呼び出しを挿入します
${object.superToString}super.toString() の呼び出しを挿入します
${object.hashCode}this.hashCode() の呼び出しを挿入します
${object.identityHashCode}System.identityHashCode(this) の呼び出しを挿入します
${member.name}最初のメンバーの名前を挿入します
${member.name()}最初のメンバーの名前を挿入し、メソッドの場合は括弧を続けます
${member.value}最初のメンバーの値を挿入します
${otherMembers}残りのメンバーを挿入します。メンバーごとに、最初と最後の ${member.*} 変数の間のテンプレート・フラグメントが評価されて、結果に追加されます。最後の ${member.*} と ${otherMembers} の間の文字によって、メンバー間に挿入されるセパレーターが定義されます (${otherMembers} は、最後の ${member.*} 変数の後で開始される必要あり)。

テンプレートが適切に機能するには、${otherMembers} 変数をテンプレート内で 1 回だけ使用する必要があり、その後に ${member.*} 変数を続けることはできません。${object.*} 変数はテンプレート内の任意の場所に配置できますが、 メンバーに関連するフラグメント内 (つまり、最初の ${member.*} 変数と ${otherMembers} の間) に配置した場合、その変数がすべてのメンバーについて繰り返されることになります。これは理にかなった方法ではありません。

上記の説明は複雑に思えるかもしれませんが、テンプレート・フォーマット自体は非常に簡単に使用できます。実例をいくつか見てみると、はっきりします。

テンプレートの例

  1. 以下に示すデフォルト・テンプレートは 1 つの良い例です。

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

    このテンプレートの出力ストリングは以下のようになります。

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. 以下のような複数行の出力も使用可能です。

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

    結果の例:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. メンバーを中括弧で囲む場合は、以下のように ${otherMembers} 変数も同じようにしてください。

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

    この結果は以下のとおりです。

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. ${object.*} 変数は、以下のようにテンプレートの先頭と末尾で使用できます。

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

    このテンプレートの結果は、以下のような出力になります。

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

関連参照

「toString() の生成」ダイアログ
toString() 生成プログラム: コード・スタイル
toString() 生成プログラム: 内容のリスト作成