Existe-t-il un moyen de supposer @Nullable par défaut? (En utilisant FindBugs ou tout autre outil gratuit)

Question

Tenir compte un tel code

public void m1(String text) { 
    if(text == null) 
     text = "<empty>"; 

    System.out.println(text.toLowerCase()); 
} 

Et ceci est une version buggy:

public void m1(String text) { 
    System.out.println(text.toLowerCase()); 
} 

Si la valeur nulle a été transmise, le NullPointerException peut être jeté. Je voudrais que l'outil d'analyse statique (par exemple FindBugs) signale ce problème. En vain, le FindBugs (au moins par défaut) me demande de spécifier explicitement l'annotation @Nullable. Le problème est que si j'oublie d'annoter, le bug sera manqué !!!

Comment puis-je faire en sorte que FindBugs (ou tout autre outil gratuit) assume @Nullable par défaut?

Answer 1

Selon Javadoc:

@DefaultAnnotationForParameters indique que tous les membres de la classe ou de l'emballage doivent être annotés avec la valeur par défaut de la classe d'annotation fournie.

(BTW Javadocs pour @DefaultAnnotation, @DefaultAnnotationForFields et @DefaultAnnotationForMethods contiennent exactement le même texte).

Mais selon chapter 10 of FindBugs Manual:

Ceci est identique à la DefaultAnnotation sauf qu'il n'applys aux paramètres de la méthode.

Alors que theroretically soit

@DefaultAnnotationForParameters(value = Nullable.class) 

ou

@DefaultAnnotationForParameters({Nullable.class}) 

devrait fonctionner, deux ne le font pas.

Je ne sais pas si FindBugs soutient cela, mais avec JSR 305 vous pouvez également utiliser l'annotation @ParametersAreNullableByDefault appliquée à un paquet, classe ou méthode. Unfortunately FindBugs 1.3.9 ignores @ParametersAreNonnullByDefault and similar annotations (used on packages or on types).

Answer 2

Vous pouvez écrire votre propre détecteur dans FindBugs qui recherche toute utilisation de paramètres qui ne sont pas null vérifié. Serait relativement simple à faire.

Answer 3

Ce que vous cherchez est @ParametersAreNullableByDefault (http://code.google.com/p/jsr-305/source/browse/trunk/ri/src/main/java/javax/annotation/ParametersAreNullableByDefault.java) mais je vous invite à utiliser @ParametersAreNonnullByDefault à la place. Il aurait également détecté votre code buggy. De préférence, vous les placez dans votre fichier package-info.java sous la forme d'une annotation sur le package.