JAVA - Noms de variables couramment utilisées

JAVA - Normes pour les Noms des méthodes

Conventions de nommage des méthodes Java

Table des matières :

getXxx() : Object
setXxx(Object) : void
isXxx() : boolean
getAllXxx
createXxx
newXxx
updateXxx
addXxx
addNewXxx
addAllXxx
paramString
removeXxx
removeAllXxx
toXxx
toDebug : Object[]
checkXxx

getXxx() : Object

Getter.

setXxx(Object) : void

Setter.

isXxx() : boolean

Getter for boolean value.

getAllXxx

Returns a collection of items.

createXxx

Create an object.

newXxx

Create an object.

updateXxx

Update a value.

addXxx

Add a value.

addNewXxx

Create a value and add it.

addAllXxx

Add values.

paramString

Retourne la liste des paramètres d'une classe pour mode debug.
Cette méthode est appeler par toString(). Voir le cas des composants swing.
Exemple de la méthode por JComboBox.

protected String paramString() {
    return super.paramString() +
        ",isEditable=" + isEditableString +
        ",lightWeightPopupEnabled=" + lightWeightPopupEnabledString +
        ",maximumRowCount=" + maximumRowCount +
        ",selectedItemReminder=" + selectedItemReminderString;
}

removeXxx

Remove value.

removeAllXxx

Remove values.

toXxx

Convert to an other type.

toDebug : Object[]

Méthode pour rendre plus facile le debuggage.
J'utilise souvent la méthode toString() pour avoir une vision d'un objet facilement utilisable en mode debug.
Cependant, la méthode n'est pas toujours utilisable, de plus la représentation des longues String en mode inspection dans JBuilder n'est pas pratique. Pour ces raisons, j'utilise de plus en plus la méthode toDebug() qui retourne un tableau d'objets.
Pourquoi un tableau d'objets : par ce que cela est facilement visualisable et permet des représentations hiérarchique.
Quelques conventions :

retour[0] = this.toString().
Utiliser une list et ensuite retourner list.toArray();

Exemple : Objet contenant une map et un id.

public Object[] toDebug() {
    List retour = new ArrayList();
    retour.add(this.toString());
    retour.add("ID : " + this.getId());
    Set l_keys = map.keySet();
    Iterator it = l_keys.iterator();
    while(it.hasNext()) {
        String l_key = it.next();
        retour.add(l_key + " = " + map.get(l_key));
    }
    return retour.toArray();
}