Генератор toString(): Шаблоны формата

Шаблоны формата используются простым механизмом, который позволяет изменить формат генерируемой строки вывода метода: начало, конец, разделитель и так далее. Они выглядят подобно шаблонам исходного кода JDT, но не влияют на генерируемой исходный код непосредственно (для этого используются стили исходного кода). Ниже приведен список доступных переменных шаблона:

${object.className}вставляет имя класса как простую строку
${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}}

    Here's the effect:

    {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(): стили исходного кода