Conventions de dénomination pour les méthodes java qui renvoient booléen (pas de point d'interrogation)

J'aime utiliser le point d'interrogation à la fin des noms de méthode / fonction dans d'autres langues. Java ne me laisse pas faire ça. Pour contourner ce problème, comment puis-je nommer des méthodes de retour booléennes en Java? L' utilisation d' un is, has, should, canà l'avant d'un son de méthode acceptable pour certains cas. Existe-t-il une meilleure façon de nommer ces méthodes?

Par exemple, createFreshSnapshot?

La convention est de poser une question dans le nom.

Voici quelques exemples que l'on peut trouver dans le JDK:

isEmpty()

hasChildren()

De cette façon, les noms sont lus comme s'ils auraient un point d'interrogation à la fin.

La collection est-elle vide?
Ce nœud a-t-il des enfants?

Et, alors, truesignifie oui, et falsesignifie non.

Ou, vous pouvez le lire comme une assertion:

La collection est vide.
Le nœud a des enfants

Remarque:
Parfois, vous voudrez peut-être nommer une méthode quelque chose comme createFreshSnapshot?. Sans le point d'interrogation, le nom implique que la méthode doit créer un instantané, au lieu de vérifier si un est nécessaire.

Dans ce cas, vous devez repenser ce que vous demandez réellement. Quelque chose comme isSnapshotExpiredest un nom bien meilleur, et transmet ce que la méthode vous dira lorsqu'elle sera appelée. Suivre un modèle comme celui-ci peut également aider à garder plus de fonctions pures et sans effets secondaires.

Si vous faites une recherche Google pour isEmpty()l'API Java, vous obtenez beaucoup de résultats.

Si vous souhaitez que votre classe soit compatible avec la spécification Java Beans , de sorte que les outils utilisant la réflexion (par exemple JavaBuilders , JGoodies Binding ) puissent reconnaître les getters booléens, soit utiliser getXXXX()soit isXXXX()un nom de méthode. À partir de la spécification Java Beans:

8.3.2 Propriétés booléennes

De plus, pour les propriétés booléennes, nous autorisons une méthode getter à correspondre au modèle:

public boolean is< PropertyName > ();

Cette méthode «is < PropertyName >» peut être fournie à la place d'une méthode «get < PropertyName >», ou elle peut être fournie en plus d'une méthode «get < PropertyName >». Dans les deux cas, si la méthode «is < PropertyName >» est présente pour une propriété booléenne, nous utiliserons la méthode «is < PropertyName >» pour lire la valeur de la propriété. Un exemple de propriété booléenne pourrait être:

public boolean isMarsupial();
public void setMarsupial(boolean m);

Je souhaite publier ce lien car cela peut aider davantage les personnes qui vérifient cette réponse et recherchent plus de convention de style java

Instructions de style de programmation Java

L'élément "2.13 est le préfixe doit être utilisé pour les variables et méthodes booléennes." est spécifiquement pertinent et suggère le préfixe is .

Le guide de style continue en suggérant:

Il existe quelques alternatives au préfixe is qui s'adaptent mieux dans certaines situations. Ce sont les préfixes has , can et should :

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

Si vous suivez les directives, je pense que la méthode appropriée serait nommée:

shouldCreateFreshSnapshot()

Pour les méthodes qui peuvent échouer, c'est-à-dire que vous spécifiez booléen comme type de retour, j'utiliserais le préfixe try:

if (tryCreateFreshSnapshot())
{
  // ...
}

Pour tous les autres cas, utilisez des préfixes comme is.. has.. was.. can.. allows....

La norme est d'utiliser «est» ou «a» comme préfixe. Par exemple isValid, hasChildren.

isest celui que j'ai rencontré plus que tout autre. Ce qui a du sens dans la situation actuelle est cependant la meilleure option.

Je veux montrer un point de vue différent sur cette convention de dénomination générale , par exemple:

voir java.util.Set :boolean add​(E e)

où la justification est:

effectuez un traitement puis indiquez s'il a réussi ou non .

Alors que le returnest en effet un, booleanle nom de la méthode doit pointer le traitement à terminer au lieu du type de résultat (booléen pour cet exemple).

Votre createFreshSnapshotexemple me semble plus lié à ce point de vue car il semble vouloir dire ceci: créez un instantané frais puis indiquez si l'opération de création a réussi. Compte tenu de ce raisonnement, le nom createFreshSnapshotsemble être le meilleur pour votre situation.