Générateur toString() : modèles de formats

Les modèles de formats sont utilisés par un mécanisme simple qui permet de changer le format de la chaîne de sortie d'une méthode générée : début, fin, séparateur etc. Leur apparence est similaire à celle des modèles de code JDT, mais ils n'affectent pas directement le code généré (des styles de code sont utilisés à cet effet). Voici la liste des modèles de variables disponibles :

${object.className}insère le nom de classe sous la forme d'une chaîne simple
${object.getClassName}insère un appel à this.getClass.getName()
${object.superToString}insère un appel à super.toString()
${object.hashCode}insère un appel à this.hashCode()
${object.identityHashCode}insère un appel à System.identityHashCode(this)
${member.name}insère le nom du premier membre
${member.name()}insère le nom du premier membre suivi de parenthèses en cas de méthodes
${member.value}insère la valeur du premier membre
${otherMembers}insère les membres restants. Pour chaque membre, le fragment de modèle entre la première et la dernière variables ${member.*} est évalué et ajouté au résultat. Les caractères entre la dernière variable ${member.*} et la variable ${otherMembers} définissent le séparateur qui est inséré entre les membres (${otherMembers} doit se trouver après la dernière variable ${member.*}).

Pour que le modèle fonctionne correctement, la variable ${otherMembers} doit être utilisée exactement une fois dans un modèle et elle ne peut pas être suivie d'une autre variable ${member.*}. Les variables ${object.*} peuvent être placées n'importe où dans le modèle, mais si l'une d'entre elles se trouve dans un fragment associé à un membre (à savoir entre la première variable ${member.*} et ${otherMembers}), elle est répétée pour chaque membre, ce qui n'est pas une bonne solution.

La description ci-dessus peut sembler compliquée, mais le format de modèle lui-même est très simple à utiliser. Quelques exemples pratiques faciliteront la compréhension.

Exemples de modèles

  1. Le modèle par défaut est un bon exemple :

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

    La chaîne de sortie de ce modèle se présente comme suit :

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. Une sortie de plusieurs lignes est également disponible :

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

    Exemple de résultat :

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. Si vous placez un membre entre accolades, n'omettez pas de placer la variable ${otherMembers} entre parenthèses :

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

    Here's the effect:

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. Les variables ${object.*} peuvent être utilisées au début et à la fin du modèle :

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

    Ce modèle génère une sortie similaire à la sortie suivante :

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

Référence connexe

Boîte de dialogue Générer toString()
Générateur toString() : styles de code
Générateur toString() : liste de contenu