Convenções de nomenclatura para métodos java que retornam booleano (sem ponto de interrogação)

Gosto de usar pontos de interrogação no final dos nomes de métodos / funções em outras línguas. Java não me deixa fazer isso. Como solução alternativa, de que outra forma posso nomear métodos de retorno booleanos em Java? Usando um is, has, should, canna frente de um som método bom para alguns casos. Existe uma maneira melhor de nomear esses métodos?

Por exemplo, createFreshSnapshot?

A convenção é fazer uma pergunta em nome.

Aqui estão alguns exemplos que podem ser encontrados no JDK:

isEmpty()

hasChildren()

Dessa forma, os nomes são lidos como se tivessem um ponto de interrogação no final.

A coleção está vazia?
Este Nodo tem filhos?

E, então, truesignifica sim e falsesignifica não.

Ou você pode ler como uma afirmação:

A coleção está vazia.
O nó tem filhos

Nota:
Às vezes, você pode querer nomear um método de forma semelhante createFreshSnapshot?. Sem o ponto de interrogação, o nome indica que o método deve criar um instantâneo, em vez de verificar se um é necessário.

Nesse caso, você deve repensar o que está realmente pedindo. Algo como isSnapshotExpiredé um nome muito melhor e transmite o que o método dirá quando for chamado. Seguir um padrão como esse também pode ajudar a manter mais puras de suas funções e sem efeitos colaterais.

Se você fizer uma Pesquisa Google por isEmpty()na API Java, obterá muitos resultados.

Se desejar sua classe para ser compatível com a especificação Java Beans , de modo que as ferramentas que utiliza a reflexão (por exemplo JavaBuilders , JGoodies de ligação ) pode reconhecer boolean getters, tanto para uso getXXXX()ou isXXXX()como um nome de método. Da especificação Java Beans:

8.3.2 Propriedades booleanas

Além disso, para propriedades booleanas, permitimos um método getter para corresponder ao padrão:

public boolean is< PropertyName > ();

Este método “is < PropertyName >” pode ser fornecido em vez de um método “get < PropertyName >”, ou pode ser fornecido além de um método “get < PropertyName >”. Em ambos os casos, se o método “is < PropertyName >” estiver presente para uma propriedade booleana, usaremos o método “is < PropertyName >” para ler o valor da propriedade. Um exemplo de propriedade booleana pode ser:

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

Quero postar este link, pois pode ajudar ainda mais para aqueles que verificam esta resposta e procuram mais convenções de estilo java

Diretrizes de estilo de programação Java

O item "2.13 is prefix deve ser usado para variáveis ​​e métodos booleanos." é especificamente relevante e sugere o prefixo is .

O guia de estilo sugere:

Existem algumas alternativas para o prefixo is que se adaptam melhor em algumas situações. Estes são os prefixos tem , pode e deve :

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

Se você seguir as Diretrizes, acredito que o método apropriado seria nomeado:

shouldCreateFreshSnapshot()

Para métodos que podem falhar, ou seja, você especifica booleano como tipo de retorno, eu usaria o prefixo try:

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

Para todos os outros casos, use prefixos como is.. has.. was.. can.. allows....

O padrão é usar 'é' ou 'tem' como prefixo. Por exemplo isValid, hasChildren.

isé o que eu encontrei mais do que qualquer outro. O que quer que faça sentido na situação atual é a melhor opção.

Quero apontar uma visão diferente sobre esta convenção geral de nomenclatura, por exemplo:

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

onde a justificativa é:

fazer algum processamento e relatar se foi bem-sucedido ou não .

Embora returnseja realmente um, booleano nome do método deve apontar o processamento para ser concluído em vez do tipo de resultado (booleano neste exemplo).

Seu createFreshSnapshotexemplo me parece mais relacionado a este ponto de vista porque parece significar o seguinte: crie um instantâneo fresco e depois relate se a operação de criação foi bem-sucedida. Diante desse raciocínio, o nome createFreshSnapshotparece ser o mais adequado para sua situação.