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} 變數在範本中只能使用一次,且後面不能接著任何 ${member.*} 變數。${object.*} 變數可位於範本中任何位置,但如果是位於成員相關的片段中(也就是第一個 ${member.*} 變數和 ${otherMembers} 之間),則每個成員都會重複這個變數,這可能不是一個合理的解決方案。

上述說明可能有點複雜難懂,但範本格式本身很容易使用。在看過一些使用中範例後,應該就能夠完全明瞭了。

範本範例

  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() 產生器:內容清單