FindBugs Bug Descriptions

This document lists the standard bug patterns reported by FindBugs version 3.0.1.

Summary

Descriptions

BC: Equals method should not assume anything about the type of its argument (BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS)

The equals(Object o) method shouldn't make any assumptions about the type of o. It should simply return false if o is not the same type as this.

BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK)

This method compares an expression such as

((event.detail & SWT.SELECTED) > 0)

Using bit arithmetic and then comparing with the greater than operator can lead to unexpected results (of course depending on the value of SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate for a bug. Even when SWT.SELECTED is not negative, it seems good practice to use '!= 0' instead of '> 0'.

Boris Bokowski

CN: La classe implémente Cloneable mais ne définit et n'utilise pas la méthode clone() (CN_IDIOM)

La classe implémente Cloneable sans définir ou utiliser la méthode clone().

CN: La méthode clone() n'appelle pas super.clone() (CN_IDIOM_NO_SUPER_CALL)

Cette classe définit une méthode clone() qui n'appelle pas super.clone(), et n'est pas finale. Si cette classe ("A") est étendue par une classe fille ("B"), et que la classe fille B appelle super.clone(), alors il est probable que la méthode clone() de B retournera un objet de type A, ce qui viole le contrat standard de clone().

Si toutes les méthodes clone() appellent super.clone(), elles ont alors la garantie d'utiliser Object.clone(), qui retourne toujours un objet du type correct.

CN: Class defines clone() but doesn't implement Cloneable (CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE)

This class defines a clone() method but the class doesn't implement Cloneable. There are some situations in which this is OK (e.g., you want to control how subclasses can clone themselves), but just make sure that this is what you intended.

CNT: Rough value of known constant found (CNT_ROUGH_CONSTANT_VALUE)

It's recommended to use the predefined library constant for code clarity and better precision.

Co: Une classe abstraite définit une méthode compareTo() covariante (CO_ABSTRACT_SELF)

Cette classe définit une version covariante de compareTo(). Pour surcharger correctement la méthode compareTo() de l'interface Comparable, le paramètre de compareTo() doit être du type java.lang.Object.

Co: compareTo()/compare() incorrectly handles float or double value (CO_COMPARETO_INCORRECT_FLOATING)

This method compares double or float values using pattern like this: val1 > val2 ? 1 : val1 < val2 ? -1 : 0. This pattern works incorrectly for -0.0 and NaN values which may result in incorrect sorting result or broken collection (if compared values are used as keys). Consider using Double.compare or Float.compare static methods which handle all the special cases correctly.

Co: compareTo()/compare() returns Integer.MIN_VALUE (CO_COMPARETO_RESULTS_MIN_VALUE)

In some situation, this compareTo or compare method returns the constant Integer.MIN_VALUE, which is an exceptionally bad practice. The only thing that matters about the return value of compareTo is the sign of the result. But people will sometimes negate the return value of compareTo, expecting that this will negate the sign of the result. And it will, except in the case where the value returned is Integer.MIN_VALUE. So just return -1 rather than Integer.MIN_VALUE.

Co: Définition d'une méthode compareTo() covariante (CO_SELF_NO_OBJECT)

Cette classe définit une version covariante de compareTo(). Pour correctement surcharger la méthode compareTo() de l'interface Comparable, le paramètre de compareTo() doit être du type java.lang.Object.

DE: La méthode peut déclencher une exception (DE_MIGHT_DROP)

Cette méthode peut déclencher une exception. En général, les exceptions doivent être gérées ou transmises hors de la méthode.

DE: La méthode peut ignorer une exception (DE_MIGHT_IGNORE)

Cette méthode peut ignorer une exception. En général, les exceptions doivent être gérées ou transmises hors de la méthode.

DMI: Adding elements of an entry set may fail due to reuse of Entry objects (DMI_ENTRY_SETS_MAY_REUSE_ENTRY_OBJECTS)

The entrySet() method is allowed to return a view of the underlying Map in which a single Entry object is reused and returned during the iteration. As of Java 1.6, both IdentityHashMap and EnumMap did so. When iterating through such a Map, the Entry value is only valid until you advance to the next iteration. If, for example, you try to pass such an entrySet to an addAll method, things will go badly wrong.

DMI: Random object created and used only once (DMI_RANDOM_USED_ONLY_ONCE)

This code creates a java.util.Random object, uses it to generate one random number, and then discards the Random object. This produces mediocre quality random numbers and is inefficient. If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number is required invoke a method on the existing Random object to obtain it.

If it is important that the generated Random numbers not be guessable, you must not create a new Random for each random number; the values are too easily guessable. You should strongly consider using a java.security.SecureRandom instead (and avoid allocating a new SecureRandom for each random number needed).

DMI: Don't use removeAll to clear a collection (DMI_USING_REMOVEALL_TO_CLEAR_COLLECTION)

If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.

Dm: La méthode invoque System.exit(...) (DM_EXIT)

Invoquer System.exit() arrête toute la JVM. Cela ne doit être fait que lorsque c'est nécessaire. De tels appels rendent difficile ou impossible l'invocation de votre code par d'autre code. Envisagez de déclencher une RuntimeException à la place.

Dm: Méthode invoquant runFinalizersOnExit, l'une des plus dangeureuses méthodes des librairies Java (DM_RUN_FINALIZERS_ON_EXIT)

N'appelez jamais System.runFinalizersOnExit ou Runtime.runFinalizersOnExit pour quelque raison que ce soit : elles font partie des méthodes les plus dangeureuses des librairies Java

Joshua Bloch

ES: Comparison of String parameter using == or != (ES_COMPARING_PARAMETER_STRING_WITH_EQ)

This code compares a java.lang.String parameter for reference equality using the == or != operators. Requiring callers to pass only String constants or interned strings to a method is unnecessarily fragile, and rarely leads to measurable performance gains. Consider using the equals(Object) method instead.

ES: Comparaison d'objets String utilisant == ou != (ES_COMPARING_STRINGS_WITH_EQ)

Ce code compare des objets java.lang.String au moyen de l'égalité par référence des opérateurs == ou !=. A moins que les deux chaînes ne soient des constantes dans le fichier source ou aient été internalisées au moyen de la méthode String.intern(), deux chaînes identiques peuvent être représentées par deux objets String différents. Envisagez d'utiliser la méthode equals(Object) à la place.

Eq: Une classe abstraite définit une méthode equals() covariante (EQ_ABSTRACT_SELF)

Cette classe définit une version covariante de la méthode equals(). Pour surcharger correctement la méthode equals() de java.lang.Object, le paramètre de equals() doit être du type java.lang.Object.

Eq: Equals checks for incompatible operand (EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS)

This equals method is checking to see if the argument is some incompatible type (i.e., a class that is neither a supertype nor subtype of the class that defines the equals method). For example, the Foo class might have an equals method that looks like:

public boolean equals(Object o) {
  if (o instanceof Foo)
    return name.equals(((Foo)o).name);
  else if (o instanceof String)
    return name.equals(o);
  else return false;

This is considered bad practice, as it makes it very hard to implement an equals method that is symmetric and transitive. Without those properties, very unexpected behavoirs are possible.

Eq: Class defines compareTo(...) and uses Object.equals() (EQ_COMPARETO_USE_OBJECT_EQUALS)

This class defines a compareTo(...) method but inherits its equals() method from java.lang.Object. Generally, the value of compareTo should return zero if and only if equals returns true. If this is violated, weird and unpredictable failures will occur in classes such as PriorityQueue. In Java 5 the PriorityQueue.remove method uses the compareTo method, while in Java 6 it uses the equals method.

From the JavaDoc for the compareTo method in the Comparable interface:

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

Eq: equals method fails for subtypes (EQ_GETCLASS_AND_CLASS_CONSTANT)

This class has an equals method that will be broken if it is inherited by subclasses. It compares a class literal with the class of the argument (e.g., in class Foo it might check if Foo.class == o.getClass()). It is better to check if this.getClass() == o.getClass().

Eq: Définition d'une méthode equals() covariante (EQ_SELF_NO_OBJECT)

Cette classe définit une version covariante de equals(). Pour surcharger correctement la méthode equals() de java.lang.Object, le paramètre de equals() doit être du type java.lang.Object.

FI: Un finaliseur vide devrait être supprimé (FI_EMPTY)

Les méthodes finalize() vides sont inutiles, donc elles devraient être supprimées.

FI: Invocation explicite d'un finaliseur (FI_EXPLICIT_INVOCATION)

Cette méthode contient un appel explicite à la méthode finalize() d'un objet. Les méthodes finalize() étant sensées n'être appelées qu'une fois, et uniquement par la JVM, c'est une mauvaise idée.

FI: Finalizer nulls fields (FI_FINALIZER_NULLS_FIELDS)

This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection, and the object is going to be garbage collected anyway.

FI: Finalizer only nulls fields (FI_FINALIZER_ONLY_NULLS_FIELDS)

This finalizer does nothing except null out fields. This is completely pointless, and requires that the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize method.

FI: Le finaliseur n'appelle pas le finaliseur de la super-classe (FI_MISSING_SUPER_CALL)

Cette méthode finalize() n'appelle pas la méthode finalize() de sa classe mère ; donc toutes les actions définies au niveau de la classe mère seront ignorées. Ajoutez un appel à super.finalize().

FI: Un finaliseur rend inutile celui de sa super-classe (FI_NULLIFY_SUPER)

Cette méthode finalize() vide rend explicitement inutile tout finaliseur défini dans les super-classes. Toute action définie dans un finaliseur d'une superclasse sera ignorée. A moins que cela ne soit voulu, supprimer cette méthode.

FI: Le finaliseur ne fait rien sauf appeler celui de la super-classe (FI_USELESS)

La seule chose que cette méthode finalize() fait est d'appeler la méthode finalize() de la super-classe, ce qui la rend redondante. Supprimez la.

FS: Format string should use %n rather than \n (VA_FORMAT_STRING_USES_NEWLINE)

This format string include a newline character (\n). In format strings, it is generally preferable better to use %n, which will produce the platform-specific line separator.

GC: Unchecked type in generic call (GC_UNCHECKED_TYPE_IN_GENERIC_CALL)

This call to a generic collection method passes an argument while compile type Object where a specific type from the generic type parameters is expected. Thus, neither the standard Java type system nor static analysis can provide useful information on whether the object being passed as a parameter is of an appropriate type.

HE: La classe définit equals() mais pas hashCode() (HE_EQUALS_NO_HASHCODE)

Cette classe surcharge equals(Object), mais pas hashCode(). C'est pourquoi la classe peut violer le contrat indiquant que des objets égaux doivent avoir des codes de hachage identiques.

HE: La classe définit equals() et utilise Object.hashCode() (HE_EQUALS_USE_HASHCODE)

Cette classe surcharge equals(Object), pas hashCode(), et hérite de l'implémentation de hashCode() issue de java.lang.Object (qui renvoie le code de hachage d'identité, une valeur arbitraire assignée à l'objet par la JVM). C'est pourquoi la classe a des chances de violer le contrat impliquant que des objets égaux doivent avoir des codes de hachage identiques.

Si vous ne pensez pas que des instances de cette classe soient un jour insérés dans desHashMap/Hashtable, l'implémentation recommendée est du type :

public int hashCode() {
  assert false : "hashCode not designed";
  return 42; // any arbitrary constant will do 
}

HE: La classe définit hashCode() mais pas equals() (HE_HASHCODE_NO_EQUALS)

Cette classe définit une méthode hashCode() mais pas de méthode equals(). C'est pourquoi cette classe peut violer le contrat indiquant que des objets identiques doivent avoir des codes de hachage identiques.

HE: La classe définit hashCode() et utilise Object.equals() (HE_HASHCODE_USE_OBJECT_EQUALS)

Cette classe définit une méthode hashCode() mais hérite la méthode equals() de java.lang.Object (qui définit l'égalité par comparaison des références des objets). Bien que cela satisfasse certainement le contrat indiquant que les objets égaux doivent avoir des codes de hachage égaux, ce n'est certainement pas ce qui était voulu lors de la surcharge de la méthode hashCode() (Surcharger hashCode() implique que l'identité des objets soit basée sur des critères plus compliqués qu'une simple égalités des références.)

Si vous ne pensez pas que des instances de cette classe soient un jour insérées dans des HashMap/HashTable, l'implémentation recommendée de hashCode est :

public int hashCode() {
  assert false : "hashCode not designed";
  return 42; // any arbitrary constant will do 
  }

HE: La classe hérite de equals() et utilise Object.hashCode() (HE_INHERITS_EQUALS_USE_HASHCODE)

Cette classe hérite de la méthode equals((Object) d'une super-classe abstraite, et de la méthode hashCode() de l'objet java.lang.Object (qui renvoi le code de hachage d'identité, une valeur arbitraire assignée à l'objet par la JVM). C'est pourquoi la classe viole probablement le contrat indiquant que des objets égaux doivent avoir des codes de hachage identiques.

Si vous ne souhaitez pas définir une méthode hashCode() et/ou ne pensez pas que l'objet puisse un jour être mis dans des HashMap/Hashtable, définissez une méthode hashCode() déclenchant une UnsupportedOperationException.

IC: Classe mère utilisant une sous-classe durant son initialisation (IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION)

Durant l'intialisation, une classe utilise activement l'une de ses sous-classes. Cette sous-classe ne sera pas encore initialisée lors de la première utilisation. Par exemple, dans le code suivant, foo sera à null.

public class CircularClassInitialization {
    static class InnerClassSingleton extends CircularClassInitialization {
        static InnerClassSingleton singleton = new InnerClassSingleton();
    }
    static CircularClassInitialization foo = InnerClassSingleton.singleton;
}

IMSE: Interception douteuse d'une IllegalMonitorStateException (IMSE_DONT_CATCH_IMSE)

IllegalMonitorStateException n'est généralement déclenchée que dans le cas d'une faille dans la conception du code (appeler wait() ou notify() sur un objet dont on ne possède pas le verrou).

ISC: Instantiation inutile d'une classe qui n'a que des méthodes statiques (ISC_INSTANTIATE_STATIC_CLASS)

Cette classe alloue un objet basé sur une classe qui n'a que des méthodes statiques. Cet objet n'a pas besoin d'être créé, accédez directement aux méthodes en utilisant le nom de la classe.

It: La méthode next() de Iterator ne peut pas déclencher une exception NoSuchElement (IT_NO_SUCH_ELEMENT)

Cette classe implémente l'interface java.util.Iterator. Néanmoins, sa méthode next() n'est pas capable de déclencher java.util.NoSuchElementException. La méthode next() devrait être modifiée pour déclencher NoSuchElementException si elle est appelée alors qu'il n'y a plus d'éléments à renvoyer.

J2EE: Stockage d'un objet non serialisable dans une session Http (J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION)

Ce code semble stocker un objet non sérialisable dans un HttpSession. Une erreur se produira si cette session est rendue passive ou migrée.

JCIP: Les champs d'une classe immuable devraient être finaux. (JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS)

ME: Public enum method unconditionally sets its field (ME_ENUM_FIELD_SETTER)

This public method declared in public enum unconditionally sets enum field, thus this field can be changed by malicious code or by accident from another package. Though mutable enum fields may be used for lazy initialization, it's a bad practice to expose them to the outer world. Consider removing this method or declaring it package-private.

ME: Enum field is public and mutable (ME_MUTABLE_ENUM_FIELD)

A mutable public field is defined inside a public enum, thus can be changed by malicious code or by accident from another package. Though mutable enum fields may be used for lazy initialization, it's a bad practice to expose them to the outer world. Consider declaring this field final and/or package-private.

NP: Method with Boolean return type returns explicit null (NP_BOOLEAN_RETURN_NULL)

A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen. This method can be invoked as though it returned a value of type boolean, and the compiler will insert automatic unboxing of the Boolean value. If a null value is returned, this will result in a NullPointerException.

NP: Clone method may return null (NP_CLONE_COULD_RETURN_NULL)

This clone method seems to return null in some circumstances, but clone is never allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError instead.

NP: Méthode equals() ne vérifiant pas la nullité (NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT)

Cette implémentation de equals(Object) ne respecte pas le contrat défini par java.lang.Object.equals() car elle ne vérifie la nullité du paramètre reçu en argument. Toutes les méthodes equals() doivent renvoyer false quand elles reçoivent une valeur à null.

NP: toString method may return null (NP_TOSTRING_COULD_RETURN_NULL)

This toString method seems to return null in some circumstances. A liberal reading of the spec could be interpreted as allowing this, but it is probably a bad idea and could cause other code to break. Return the empty string or some other appropriate string rather than null.

Nm: Nom de classe devant commencer par une majuscule (NM_CLASS_NAMING_CONVENTION)

Les noms de classe doivent être en minuscules avec la première lettre de chaque mot en majuscules. Essayez de conserver vos noms de classes simples et explicites. Utilisez des mots entiers et évitez acronymes et abbréviations (à moins que l'abbréviation soit plus largement utilisée que la forme longue, comme "URL" ou "HTML").

Nm: Cette classe ne dérive pas d'Exception, même si son nom le sous-entend (NM_CLASS_NOT_EXCEPTION)

Cette classe n'est pas dérivée d'une autre Exception alors que son nom se termine par 'Exception'. Ceci risque de porter à confusion les utilisateurs de cette classe.

Nm: Noms de méthodes ambigus (NM_CONFUSING)

Les méthodes indiquées ont des noms qui ne diffèrent que par les majuscules.

Nm: Nom de champ devant commencer par une minuscule (NM_FIELD_NAMING_CONVENTION)

Les noms de champs qui ne sont pas finaux devraient être en minuscules avec la première lettre des mots, après le premier, en majuscule.

Nm: Use of identifier that is a keyword in later versions of Java (NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER)

The identifier is a word that is reserved as a keyword in later versions of Java, and your code will need to be changed in order to compile it in later versions of Java.

Nm: Use of identifier that is a keyword in later versions of Java (NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER)

This identifier is used as a keyword in later versions of Java. This code, and any code that references this API, will need to be changed in order to compile it in later versions of Java.

Nm: Nom de méthode devant commencer par une minuscule (NM_METHOD_NAMING_CONVENTION)

Les noms de méthodes devraient être des verbes en minuscules, avec la première lettre des mots, après le premier, en majuscules.

Nm: Class names shouldn't shadow simple name of implemented interface (NM_SAME_SIMPLE_NAME_AS_INTERFACE)

This class/interface has a simple name that is identical to that of an implemented/extended interface, except that the interface is in a different package (e.g., alpha.Foo extends beta.Foo). This can be exceptionally confusing, create lots of situations in which you have to look at import statements to resolve references and creates many opportunities to accidentally define methods that do not override methods in their superclasses.

Nm: Class names shouldn't shadow simple name of superclass (NM_SAME_SIMPLE_NAME_AS_SUPERCLASS)

This class has a simple name that is identical to that of its superclass, except that its superclass is in a different package (e.g., alpha.Foo extends beta.Foo). This can be exceptionally confusing, create lots of situations in which you have to look at import statements to resolve references and creates many opportunities to accidentally define methods that do not override methods in their superclasses.

Nm: Very confusing method names (but perhaps intentional) (NM_VERY_CONFUSING_INTENTIONAL)

The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other. From the existence of other methods, it seems that the existence of both of these methods is intentional, but is sure is confusing. You should try hard to eliminate one of them, unless you are forced to have both due to frozen APIs.

Nm: Method doesn't override method in superclass due to wrong package for parameter (NM_WRONG_PACKAGE_INTENTIONAL)

The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match the type of the corresponding parameter in the superclass. For example, if you have:

import alpha.Foo;
public class A {
  public int f(Foo x) { return 17; }
}
----
import beta.Foo;
public class B extends A {
  public int f(Foo x) { return 42; }
  public int f(alpha.Foo x) { return 27; }
}

The f(Foo) method defined in class B doesn't override the f(Foo) method defined in class A, because the argument types are Foo's from different packages.

In this case, the subclass does define a method with a signature identical to the method in the superclass, so this is presumably understood. However, such methods are exceptionally confusing. You should strongly consider removing or deprecating the method with the similar but not identical signature.

ODR: La méthode peut ne pas fermer une ressource base de données (ODR_OPEN_DATABASE_RESOURCE)

Cette méthode crée une ressource base de données (telle qu'une connexion ou un RowSet), ne l'affecte à aucun champ, ne la passe à aucune autre méthode, ne la renvoie pas, et ne semble pas la fermer dans tous les chemins d'exécution. Ne pas fermer une ressource base de données dans tous les chemins d'exécution peut entraîner de faibles performances et poser des problèmes de communication entre la base de données et l'application.

ODR: La méthode peut ne pas fermer une ressource base de données sur une exception (ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH)

Cette méthode crée une ressource base de données (telle qu'une connexion ou un RowSet), ne l'affecte à aucun champ, ne la passe à aucune autre méthode, ne la renvoie pas, et ne semble pas la fermer dans tous les chemins d'exception. Ne pas fermer une ressource base de données peut entraîner de faibles performances et poser des problèmes de communication entre la base de données et l'application.

OS: La méthode peut ne pas fermer un flux (OS_OPEN_STREAM)

La méthode crée un objet de flux d'E/S, ne l'assigne à aucun champ, ne le passe à aucune méthode, ne le renvoit pas et ne semble pas le fermer dans tous les chemins d'exécution. Ceci peut entraîner le blocage d'un descripteur de fichier. C'est généralement une bonne idée d'utiliser un bloc finally pour s'assurer de la fermeture des flux.

OS: La méthode peut oublier de fermer un flux en cas d'exception (OS_OPEN_STREAM_EXCEPTION_PATH)

La méthode crée un flux d'E/S, ne l'affecte à aucun champ, ne le passe à aucune méthode, ne le renvoit pas, et ne semble pas le fermer dans tous les chemins d'exception possibles. Ceci peut provoquer le blocage d'un descripteur de fichier. C'est généralement une bonne idée d'utiliser un bloc finally pour garantir la fermeture des flux.

PZ: Don't reuse entry objects in iterators (PZ_DONT_REUSE_ENTRY_OBJECTS_IN_ITERATORS)

The entrySet() method is allowed to return a view of the underlying Map in which an Iterator and Map.Entry. This clever idea was used in several Map implementations, but introduces the possibility of nasty coding mistakes. If a map m returns such an iterator for an entrySet, then c.addAll(m.entrySet()) will go badly wrong. All of the Map implementations in OpenJDK 1.7 have been rewritten to avoid this, you should to.

RC: Suspicious reference comparison to constant (RC_REF_COMPARISON_BAD_PRACTICE)

This method compares a reference value to a constant using the == or != operator, where the correct way to compare instances of this type is generally with the equals() method. It is possible to create distinct instances that are equal but do not compare as == since they are different objects. Examples of classes which should generally not be compared by reference are java.lang.Integer, java.lang.Float, etc.

RC: Suspicious reference comparison of Boolean values (RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN)

This method compares two Boolean values using the == or != operator. Normally, there are only two Boolean values (Boolean.TRUE and Boolean.FALSE), but it is possible to create other Boolean objects using the new Boolean(b) constructor. It is best to avoid such objects, but if they do exist, then checking Boolean objects for equality using == or != will give results than are different than you would get using .equals(...)

RR: La méthode ignore le résultat de InputStream.read() (RR_NOT_CHECKED)

Cette méthode ignore le code retour d'une des variantes de java.io.InputStream.read() qui peut renvoyer de multiples octets. Si la valeur renvoyée n'est pas vérifiée, l'appelant ne sera pas capable de gérer correctement le cas ou moins d'octets que prévu auront été lus. C'est un bogue particulièrement insidieux car dans la plupart des programmes les lectures renvoient effectivement souvent le nombre d'octets demandé, les plantages restant sporadiques.

RR: La méthode ignore le résultat de InputStream.skip() (SR_NOT_CHECKED)

Cette méthode ignore la valeur renvoyée par java.io.InputStream.skip(), qui peut sauter de multiples octets. Si la valeur renvoyée n'est pas vérifiée, l'appelant n'est pas capable de gérer correctement les cas ou moins d'octets que prévu auront été sautés. C'est un type de bogue particulièrement insidieux car la plupart du temps le bon nombre d'octet sera effectivement sauté, et les plantages seront sporadiques. Néanmoins, sur les flux bufferisés, skip() ne s'applique qu'aux données du buffer et échoue fréquemment à sauter le nombre d'octets demandé.

RV: Negating the result of compareTo()/compare() (RV_NEGATING_RESULT_OF_COMPARETO)

This code negatives the return value of a compareTo or compare method. This is a questionable or bad programming practice, since if the return value is Integer.MIN_VALUE, negating the return value won't negate the sign of the result. You can achieve the same intended result by reversing the order of the operands rather than by negating the results.

RV: Method ignores exceptional return value (RV_RETURN_VALUE_IGNORED_BAD_PRACTICE)

This method returns a value that is not checked. The return value should be checked since it can indicate an unusual or unexpected function execution. For example, the File.delete() method returns false if the file could not be successfully deleted (rather than throwing an Exception). If you don't check the result, you won't notice if the method invocation signals unexpected behavior by returning an atypical return value.

SI: Initialiseur statique de classe créant une instance avant que tous les champs static final soient alimentés (SI_INSTANCE_BEFORE_FINALS_ASSIGNED)

L'initialiseur static de la classe crée une instance de la classe avant que tous les champs static final soient alimentés.

SW: Certaines méthodes Swing ne doivent être invoquées qu'à partir du thread Swing (SW_SWING_METHODS_INVOKED_IN_SWING_THREAD)

(Conseil technique JDC) : les méthodes Swing show(), setVisible() et pack() créent les ressources associées à la fenêtre. En même temps que la création de ces ressources, le système crée le processus Swing de répartition de évènements.

Ceci pose problème car le processus de répartition des évènements peut notifier des écouteurs alors que pack() et validate() sont toujours en cours de traitement. Cette situation peut conduire à ce que deux processus essayent d'accèder en même temps au composant, ce qui est une faille sérieuse qui peut provoquer des interblocages et autres problèmes de synchronisation.

Un appel à pack() provoque l'initialisation du composant. Quand ils s'initialisent (sans être forcément visibles), les composants peuvent émettre des évènements vers le processus de répartition des évènements de Swing.

Se: Champ d'instance non transient et non sérialisable dans une classe sérialisable (SE_BAD_FIELD)

Cette classe Serializable définit un champ d'instance non primitif qui n'est ni transient, ni Serializable ou java.lang.Object, et qui ne semble pas implémenter l'interface Externalizable ou les méthodes readObject() et writeObject(). Les objets de cette classe ne seront pas désérialisés correctement si un objet non Serializable est stocké dans ce champ.

Se: Non-serializable class has a serializable inner class (SE_BAD_FIELD_INNER_CLASS)

This Serializable class is an inner class of a non-serializable class. Thus, attempts to serialize it will also attempt to associate instance of the outer class with which it is associated, leading to a runtime error.

If possible, making the inner class a static inner class should solve the problem. Making the outer class serializable might also work, but that would mean serializing an instance of the inner class would always also serialize the instance of the outer class, which it often not what you really want.

Se: Valeur non sérialisable stockée dans un champ d'instance de classe sérialisable (SE_BAD_FIELD_STORE)

Une valeur non sérialisable est stockée dans un champ non transient d'une classe sérialisable.

Se: Comparateur n'implémentant pas Serializable (SE_COMPARATOR_SHOULD_BE_SERIALIZABLE)

Cette classe implémente l'interface Comparator. Vous devriez vérifier si elle doit ou pas également implémenter l'interface Serializable. Si un comparateur est utilisé pour construire une collection triée, telle que TreeMap, alors le TreeMap ne sera sérialisable uniquement si le compareteur l'est aussi. Puisque la plupart des comparateurs ont de petits voire aucun états, les rendre sérialisables est généralement une technique de programmation défensive simple et bénéfique.

Se: Serializable inner class (SE_INNER_CLASS)

This Serializable class is an inner class. Any attempt to serialize it will also serialize the associated outer instance. The outer instance is serializable, so this won't fail, but it might serialize a lot more data than intended. If possible, making the inner class a static inner class (also known as a nested class) should solve the problem.

Se: serialVersionUID n'est pas final (SE_NONFINAL_SERIALVERSIONID)

Cette classe définit un champ serialVersionUID qui n'est pas final. Ce champ devrait être rendu final si son but est de préciser l'identifiant de version utilisé pour la sérialisation.

Se: serialVersionUID n'est pas de type long (SE_NONLONG_SERIALVERSIONID)

Cette classe définit un champ serialVersionUID qui n'est pas de type long. Ce champ devrait être de type long si son but est de préciser l'identifiant de version utilisé pour la sérialisation.

Se: serialVersionUID n'est pas static (SE_NONSTATIC_SERIALVERSIONID)

Cette classe définit un champ serialVersionUID qui n'est pas statique. Le champ devrait être rendu statique si son but est de préciser l'identifiant de version utilisé pour la sérialisation.

Se: La classe est Serializable mais sa super-classe ne possède pas de constructeur par défaut visible (SE_NO_SUITABLE_CONSTRUCTOR)

Cette classe implémente l'interface Serializable mais pas sa super-classe. Quand un tel objet est désérialisé, les champs de la classe mère doivent être initialisés en invoquant le constructeur par défaut de la super-classe. Comme la super-classe n'en a pas, sérialisation et désérialisation échoueront à l'exécution.

Se: La classe est Externalizable mais ne définit pas de constructeur par défaut (SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION)

Cette classe implémente l'interface Externalizable, mais ne définit pas de constructeur par défaut. Quand les objets Externalizable sont déserialisés, ils doivent d'abord être construit au moyen du constructeur par défaut. Cette classe n'en ayant pas, sérialisation et désérialisation échoueront à l'exécution.

Se: La méthode readResolve doit retourner un Object (SE_READ_RESOLVE_MUST_RETURN_OBJECT)

Pour que la méthode readResolve soit prise en compte pas le mécanisme de sérialisation, elle doit avoir Object comme type de retour.

Se: Champ "transient" non positionné lors de la désérialisation (SE_TRANSIENT_FIELD_NOT_RESTORED)

Cette classe contient un champ qui est mis-à-jour à de nombreux endrois dans la classe, et qui semble faire parti du démarrage de la classe. Mais, ce champ étant marqué comme transient et n'étant pas alimenté par les méthodes readObject et readResolve, il contiendra la valeur par défaut dans toutes les instances désérialisées de la classe.

SnVI: La classe est Serializable, mais ne définit pas serialVersionUID (SE_NO_SERIALVERSIONID)

Cette classe implémente l'interface Serializable mais ne définit pas de champ serialVersionUID. Une modification aussi simple qu'ajouter une référence vers un objet .class ajoutera des champs synthétiques à la classe, ce qui malheureusement changera la valeur implicite de serialVersionUID (Ex. : ajouter une référence à String.class générera un champ statique class$java$lang$String). De plus, différents compilateurs source vers bytecode peuvent utiliser différentes conventions de nommage pour les variables synthétiques générées pour référencer les objets classes et les classes internes. Afin de garantir l'interopérabilité de Serializable suivant les versions, pensez à ajouter un champ serialVersionUID explicite.

UI: L'utilisation de GetResource peut-être instable si la classe est étendue (UI_INHERITANCE_UNSAFE_GETRESOURCE)

Appeler this.getClass().getResource(...) peut rendre des résultats différents de ceux attendus si la classe est étendue par une classe d'un autre paquetage.

BC: Transtypage impossible (BC_IMPOSSIBLE_CAST)

Ce trantypage lancera toujours une exception ClassCastException.

BC: Impossible downcast (BC_IMPOSSIBLE_DOWNCAST)

This cast will always throw a ClassCastException. The analysis believes it knows the precise type of the value being cast, and the attempt to downcast it to a subtype will always fail by throwing a ClassCastException.

BC: Impossible downcast of toArray() result (BC_IMPOSSIBLE_DOWNCAST_OF_TOARRAY)

This code is casting the result of calling toArray() on a collection to a type more specific than Object[], as in:

String[] getAsArray(Collection<String> c) {
  return (String[]) c.toArray();
  }

This will usually fail by throwing a ClassCastException. The toArray() of almost all collections return an Object[]. They can't really do anything else, since the Collection object has no reference to the declared generic type of the collection.

The correct way to do get an array of a specific type from a collection is to use c.toArray(new String[]); or c.toArray(new String[c.size()]); (the latter is slightly more efficient).

There is one common/known exception exception to this. The toArray() method of lists returned by Arrays.asList(...) will return a covariantly typed array. For example, Arrays.asArray(new String[] { "a" }).toArray() will return a String []. FindBugs attempts to detect and suppress such cases, but may miss some.

BC: instanceof renverra toujours faux (BC_IMPOSSIBLE_INSTANCEOF)

Ce test instanceof renverra toujours faux. Même s'il est sûr, assurez-vous qu'il ne s'agisse pas d'une erreur logique ou d'une mauvaise compréhension.

BIT: Bitwise add of signed byte value (BIT_ADD_OF_SIGNED_BYTE)

Adds a byte value and a value which is known to have the 8 lower bits clear. Values loaded from a byte array are sign extended to 32 bits before any any bitwise operations are performed on the value. Thus, if b[0] contains the value 0xff, and x is initially 0, then the code ((x << 8) + b[0]) will sign extend 0xff to get 0xffffffff, and thus give the value 0xffffffff as the result.

In particular, the following code for packing a byte array into an int is badly wrong:

int result = 0;
for(int i = 0; i < 4; i++)
  result = ((result << 8) + b[i]);

The following idiom will work instead:

int result = 0;
for(int i = 0; i < 4; i++)
  result = ((result << 8) + (b[i] & 0xff));

BIT: Masques binaires incompatibles (BIT_AND)

Cette méthode compare une expression de la forme (a & C) avec D, qui est toujours inégale en raison des valeurs spécifiques des constantes C et D. Cela peut indiquer une faute de frappe ou une erreur logique.

BIT: Masques binaires incompatibles (BIT_AND_ZZ)

Cette méthode compare une expression de la forme (a & 0) avec 0, qui est toujours égale. Ceci peut indiquer une faute de frappe ou une erreur logique.

BIT: Masques binaires incompatibles (BIT_IOR)

Cette méthode compare une expression de la forme (a | C) avec D, qui est toujours inégale en raison des valeurs spécifiques des constantes C et D. Ceci peut indiquer une erreur logique ou une faute de frappe.

Typiquement, ce bogue arrive quand du code essaye d'effectuer un test d'apparition d'un bit mais utilise l'opérateur OU ("|") au lieu de l'opérateur ET ("&").

BIT: Ou binaire d'un octet signé (BIT_IOR_OF_SIGNED_BYTE)

Charge une valeur à partir d'un tableau d'octets et effectue un ou binaire sur cette valeur. Les valeurs venant d'un tableau d'octet sont signées et risquent donc de ne pas se comporter comme prévue.

BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK_HIGH_BIT)

This method compares an expression such as

((event.detail & SWT.SELECTED) > 0)

Using bit arithmetic and then comparing with the greater than operator can lead to unexpected results (of course depending on the value of SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate for a bug. Even when SWT.SELECTED is not negative, it seems good practice to use '!= 0' instead of '> 0'.

Boris Bokowski

BOA: La classe surcharge mal une méthode implémentée dans une superclasse Adapter (BOA_BADLY_OVERRIDDEN_ADAPTER)

Cette méthode surcharge une méthode provenant d'une classe mère qui est un Adapter qui implémente un Listener défini dans le paquetage java.awt.event ou javax.swing.event. En conséquence, cette méthode ne sera pas appelée quand l'évènement se produira.

BSHIFT: Possible bad parsing of shift operation (BSHIFT_WRONG_ADD_PRIORITY)

The code performs an operation like (x << 8 + y). Although this might be correct, probably it was meant to perform (x << 8) + y, but shift operation has a lower precedence, so it's actually parsed as x << (8 + y).

BSHIFT: Décalage d'un int hors de proportion (0..31) (ICAST_BAD_SHIFT_AMOUNT)

Un décalage de n bits est effectué avec n hors des limites (0..31). Ceci résulte en l'utilisation des 5 bits inférieurs de l'entier pour décider de la valeur du décalage. Ce n'est sans doute pas l'effet recherché et est pour le moins source de confusion.

DLS: Useless increment in return statement (DLS_DEAD_LOCAL_INCREMENT_IN_RETURN)

This statement has a return such as return x++;. A postfix increment/decrement does not impact the value of the expression, so this increment/decrement has no effect. Please verify that this statement does the right thing.

DLS: Dead store of class literal (DLS_DEAD_STORE_OF_CLASS_LITERAL)

This instruction assigns a class literal to a variable and then never uses it. The behavior of this differs in Java 1.4 and in Java 5. In Java 1.4 and earlier, a reference to Foo.class would force the static initializer for Foo to be executed, if it has not been executed already. In Java 5 and later, it does not.

See Sun's article on Java SE compatibility for more details and examples, and suggestions on how to force class initialization in Java 5.

DLS: Incrémentation annulée (DLS_OVERWRITTEN_INCREMENT)

Ce code incrémente une valeur (ex., i++) et en annule immédiatement l'effet. Par exemple, i = i++ réécrit de façon immédiate la valeur incrémentée avec la valeur originale.

DMI: Reversed method arguments (DMI_ARGUMENTS_WRONG_ORDER)

The arguments to this method call seem to be in the wrong order. For example, a call Preconditions.checkNotNull("message", message) has reserved arguments: the value to be checked is the first argument.

DMI: Valeur constante pour un mois en dehors de l'intervalle attendu de 0 à 11 (DMI_BAD_MONTH)

Ce code passe une constante mois en dehors de l'intervalle de 0 à 11.

DMI: BigDecimal constructed from double that isn't represented precisely (DMI_BIGDECIMAL_CONSTRUCTED_FROM_DOUBLE)

This code creates a BigDecimal from a double value that doesn't translate well to a decimal number. For example, one might assume that writing new BigDecimal(0.1) in Java creates a BigDecimal which is exactly equal to 0.1 (an unscaled value of 1, with a scale of 1), but it is actually equal to 0.1000000000000000055511151231257827021181583404541015625. You probably want to use the BigDecimal.valueOf(double d) method, which uses the String representation of the double to create the BigDecimal (e.g., BigDecimal.valueOf(0.1) gives 0.1).

DMI: Méthode hasNext() appelant next() (DMI_CALLING_NEXT_FROM_HASNEXT)

La méthode hasNext() appelle la méthode next(). C'est très probablement faux puisque la méthode hasNext() n'est pas changer l'état de l'itérateur tandis que la méthode next() doit changer cet état.

DMI: Collections should not contain themselves (DMI_COLLECTIONS_SHOULD_NOT_CONTAIN_THEMSELVES)

This call to a generic collection's method would only make sense if a collection contained itself (e.g., if s.contains(s) were true). This is unlikely to be true and would cause problems if it were true (such as the computation of the hash code resulting in infinite recursion). It is likely that the wrong value is being passed as a parameter.

DMI: D'oh! A nonsensical method invocation (DMI_DOH)

This partical method invocation doesn't make sense, for reasons that should be apparent from inspection.

DMI: Invocation of hashCode on an array (DMI_INVOKING_HASHCODE_ON_ARRAY)

The code invokes hashCode on an array. Calling hashCode on an array returns the same value as System.identityHashCode, and ingores the contents and length of the array. If you need a hashCode that depends on the contents of an array a, use java.util.Arrays.hashCode(a).

DMI: Double.longBitsToDouble invoked on an int (DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT)

The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed as an argument. This almostly certainly is not intended and is unlikely to give the intended result.

DMI: Vacuous call to collections (DMI_VACUOUS_SELF_COLLECTION_CALL)

This call doesn't make sense. For any collection c, calling c.containsAll(c) should always be true, and c.retainAll(c) should have no effect.

Dm: La réflexion ne peut pas être utilisée pour vérifier la présence d'une annotation avec la rétention par défaut (DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION)

A moins qu'une annotation ait elle même été annotée avec une @Retention différente de la rétention "source uniquement" par défaut, l'annotation n'est pas conservée dans le fichier .class et ne peut pas être utilisée par réflexion (par exemple avec la méthode isAnnotationPresent()).

Dm: Futile attempt to change max pool size of ScheduledThreadPoolExecutor (DMI_FUTILE_ATTEMPT_TO_CHANGE_MAXPOOL_SIZE_OF_SCHEDULED_THREAD_POOL_EXECUTOR)

(Javadoc) While ScheduledThreadPoolExecutor inherits from ThreadPoolExecutor, a few of the inherited tuning methods are not useful for it. In particular, because it acts as a fixed-sized pool using corePoolSize threads and an unbounded queue, adjustments to maximumPoolSize have no useful effect.

Dm: Creation of ScheduledThreadPoolExecutor with zero core threads (DMI_SCHEDULED_THREAD_POOL_EXECUTOR_WITH_ZERO_CORE_THREADS)

(Javadoc) A ScheduledThreadPoolExecutor with zero core threads will never execute anything; changes to the max pool size are ignored.

Dm: Useless/vacuous call to EasyMock method (DMI_VACUOUS_CALL_TO_EASYMOCK_METHOD)

This call doesn't pass any objects to the EasyMock method, so the call doesn't do anything.

Dm: Incorrect combination of Math.max and Math.min (DM_INVALID_MIN_MAX)

This code tries to limit the value bounds using the construct like Math.min(0, Math.max(100, value)). However the order of the constants is incorrect: it should be Math.min(100, Math.max(0, value)). As the result this code always produces the same result (or NaN if the value is NaN).

EC: Utilisation de equals() pour comparer un tableau et un objet (EC_ARRAY_AND_NONARRAY)

Cette méthode appelle equals(Object o) pour comparer un tableau et une référence qui ne semble pas être un tableau. Si les choses comparées sont de type différents, il est garanti qu'elles seront non égales et la comparaison est probablement une erreur. Même si les deux sont des tableaux, la méthode equals() détermine seulement si les deux tableaux sont le même objet. Pour comparer le contenu de deux tableaux, utilisez java.util.Arrays.equals(Object[], Object[]).

EC: Appel à equals() sur un tableau équivalent à == (EC_BAD_ARRAY_COMPARE)

Cette méthode invoque la méthode equals(Object o) d'un tableau. Comme les tableaux ne surchargent pas la méthode equals() de Object, cet appel revient à comparer les adresses. Pour comparer les contenus de tableaux, utilisez java.util.Arrays.equals(Object[], Object[]).

EC: equals(...) used to compare incompatible arrays (EC_INCOMPATIBLE_ARRAY_COMPARE)

This method invokes the .equals(Object o) to compare two arrays, but the arrays of of incompatible types (e.g., String[] and StringBuffer[], or String[] and int[]). They will never be equal. In addition, when equals(...) is used to compare arrays it only checks to see if they are the same array, and ignores the contents of the arrays.

EC: Appel de equals() avec un argument à null (EC_NULL_ARG)

Cette méthode appelle equals(Object), passant une valeur à null comme argument. D'après le contrat de la méthode equals(), cet appel devrait systématiquement renvoyer false.

EC: Appel de equals() comparant une classe et une interface sans relation (EC_UNRELATED_CLASS_AND_INTERFACE)

Cette méthode appelle equals(Object) sur deux références, l'une de classe, l'autre d'interface, alors que ni la classe, ni aucune de ses sous classes abstraites n'implémente l'interface. Les objets comparés ne font donc probablement pas partie de la même hiérarchie de classe à l'exécution (à moins que certaines classes de l'application n'est pas été analysées ou soient chargées dynamiquement à l'exécution). En accord avec le contrat de equals(), des objets de classes différentes doivent toujours être non égaux, donc le résultat de cette comparaison par java.lang.Object.equals(Object) renverra systèmatiquement false à l'exécution.

EC: Appel de equals() comparant différentes interfaces (EC_UNRELATED_INTERFACES)

Cette méthode appelle equals(Object) pour deux références d'interfaces sans rapport, aucune n'étant un sous-type de l'autre et aucune classe non abstraite implémentant les deux interfaces. Les objets comparés ne sont donc probablement pas de la même classe à l'éxécution (au moins que certaines classes de l'application n'aient pas été analysées ou qu'il y ait des chargements dynamiques). D'après le contrat de equals(), les objets de classes différentes devraient toujours être inégaux.

EC: Appel de equals() comparant des types différents (EC_UNRELATED_TYPES)

Cette méthode appelle equals(Object) pour deux références de type différents, sans sous-classe commune. Les objets comparés ne sont donc probablement pas de la même classe à l'éxécution (au moins que certaines classes de l'application n'aient pas été analysées ou qu'il y ait des chargements dynamiques). D'après le contrat de equals(), les objets de classes différentes devraient toujours être inégaux, c'est pourquoi la comparaison a de fortes chances de toujours renvoyer false à l'exécution.

EC: Using pointer equality to compare different types (EC_UNRELATED_TYPES_USING_POINTER_EQUALITY)

This method uses using pointer equality to compare two references that seem to be of different types. The result of this comparison will always be false at runtime.

Eq: equals method always returns false (EQ_ALWAYS_FALSE)

This class defines an equals method that always returns false. This means that an object is not equal to itself, and it is impossible to create useful Maps or Sets of this class. More fundamentally, it means that equals is not reflexive, one of the requirements of the equals method.

The likely intended semantics are object identity: that an object is equal to itself. This is the behavior inherited from class Object. If you need to override an equals inherited from a different superclass, you can use use:

public boolean equals(Object o) { return this == o; }

Eq: equals method always returns true (EQ_ALWAYS_TRUE)

This class defines an equals method that always returns true. This is imaginative, but not very smart. Plus, it means that the equals method is not symmetric.

Eq: equals method compares class names rather than class objects (EQ_COMPARING_CLASS_NAMES)

This method checks to see if two objects are the same class by checking to see if the names of their classes are equal. You can have different classes with the same name if they are loaded by different class loaders. Just check to see if the class objects are the same.

Eq: Covariant equals() method defined for enum (EQ_DONT_DEFINE_EQUALS_FOR_ENUM)

This class defines an enumeration, and equality on enumerations are defined using object identity. Defining a covariant equals method for an enumeration value is exceptionally bad practice, since it would likely result in having two different enumeration values that compare as equals using the covariant enum method, and as not equal when compared normally. Don't do it.

Eq: equals() method defined that doesn't override equals(Object) (EQ_OTHER_NO_OBJECT)

This class defines an equals() method, that doesn't override the normal equals(Object) method defined in the base java.lang.Object class.  Instead, it inherits an equals(Object) method from a superclass. The class should probably define a boolean equals(Object) method.

Eq: equals() method defined that doesn't override Object.equals(Object) (EQ_OTHER_USE_OBJECT)

This class defines an equals() method, that doesn't override the normal equals(Object) method defined in the base java.lang.Object class.  The class should probably define a boolean equals(Object) method.

Eq: equals method overrides equals in superclass and may not be symmetric (EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC)

This class defines an equals method that overrides an equals method in a superclass. Both equals methods methods use instanceof in the determination of whether two objects are equal. This is fraught with peril, since it is important that the equals method is symmetrical (in other words, a.equals(b) == b.equals(a)). If B is a subtype of A, and A's equals method checks that the argument is an instanceof A, and B's equals method checks that the argument is an instanceof B, it is quite likely that the equivalence relation defined by these methods is not symmetric.

Eq: Définition d'une méthode equals() covariante, Object.equals(Object) est hérité (EQ_SELF_USE_OBJECT)

Cette classe définit une version covariante de la méthode equals(), mais appelle la méthode normale equals(Object) définie dans la classe de base java.lang.Object. La classe devrait probablement définir une version non covariante de equals(). (C'est-à-dire une méthode avec la signature boolean equals(java.lang.Object).

FE: Test d'égalité avec NaN erroné (FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER)

Ce code vérifie si une valeur flottante est égale à la valeur spéciale "Not A Number" (Ex. : if (x == Double.NaN)). La sémantique de NaN fait que, par définition, aucune valeur n'est égale à Nan, y compris NaN. Donc x == Double.NaN renvoi systématiquement false.

Pour savoir si la valeur contenu dans x est la valeur particulière "Not A Number", utilisez Double.isNaN(x) (ou Float.isNaN(x) si x est en simple précision).

FS: Format string placeholder incompatible with passed argument (VA_FORMAT_STRING_BAD_ARGUMENT)

The format string placeholder is incompatible with the corresponding argument. For example, System.out.println("%d\n", "hello");

The %d placeholder requires a numeric argument, but a string value is passed instead. A runtime exception will occur when this statement is executed.

FS: The type of a supplied argument doesn't match format specifier (VA_FORMAT_STRING_BAD_CONVERSION)

One of the arguments is uncompatible with the corresponding format string specifier. As a result, this will generate a runtime exception when executed. For example, String.format("%d", "1") will generate an exception, since the String "1" is incompatible with the format specifier %d.

FS: MessageFormat supplied where printf style format expected (VA_FORMAT_STRING_EXPECTED_MESSAGE_FORMAT_SUPPLIED)

A method is called that expects a Java printf format string and a list of arguments. However, the format string doesn't contain any format specifiers (e.g., %s) but does contain message format elements (e.g., {0}). It is likely that the code is supplying a MessageFormat string when a printf-style format string is required. At runtime, all of the arguments will be ignored and the format string will be returned exactly as provided without any formatting.

FS: More arguments are passed than are actually used in the format string (VA_FORMAT_STRING_EXTRA_ARGUMENTS_PASSED)

A format-string method with a variable number of arguments is called, but more arguments are passed than are actually used by the format string. This won't cause a runtime exception, but the code may be silently omitting information that was intended to be included in the formatted string.

FS: Illegal format string (VA_FORMAT_STRING_ILLEGAL)

The format string is syntactically invalid, and a runtime exception will occur when this statement is executed.

FS: Format string references missing argument (VA_FORMAT_STRING_MISSING_ARGUMENT)

Not enough arguments are passed to satisfy a placeholder in the format string. A runtime exception will occur when this statement is executed.

FS: No previous argument for format string (VA_FORMAT_STRING_NO_PREVIOUS_ARGUMENT)

The format string specifies a relative index to request that the argument for the previous format specifier be reused. However, there is no previous argument. For example,

formatter.format("%<s %s", "a", "b")

would throw a MissingFormatArgumentException when executed.

GC: No relationship between generic parameter and method argument (GC_UNRELATED_TYPES)

This call to a generic collection method contains an argument with an incompatible class from that of the collection's parameter (i.e., the type of the argument is neither a supertype nor a subtype of the corresponding generic type argument). Therefore, it is unlikely that the collection contains any objects that are equal to the method argument used here. Most likely, the wrong value is being passed to the method.

In general, instances of two unrelated classes are not equal. For example, if the Foo and Bar classes are not related by subtyping, then an instance of Foo should not be equal to an instance of Bar. Among other issues, doing so will likely result in an equals method that is not symmetrical. For example, if you define the Foo class so that a Foo can be equal to a String, your equals method isn't symmetrical since a String can only be equal to a String.

In rare cases, people do define nonsymmetrical equals methods and still manage to make their code work. Although none of the APIs document or guarantee it, it is typically the case that if you check if a Collection<String> contains a Foo, the equals method of argument (e.g., the equals method of the Foo class) used to perform the equality checks.

HE: Signature declares use of unhashable class in hashed construct (HE_SIGNATURE_DECLARES_HASHING_OF_UNHASHABLE_CLASS)

A method, field or class declares a generic signature where a non-hashable class is used in context where a hashable class is required. A class that declares an equals method but inherits a hashCode() method from Object is unhashable, since it doesn't fulfill the requirement that equal objects have equal hashCodes.

HE: Use of class without a hashCode() method in a hashed data structure (HE_USE_OF_UNHASHABLE_CLASS)

A class defines an equals(Object) method but not a hashCode() method, and thus doesn't fulfill the requirement that equal objects have equal hashCodes. An instance of this class is used in a hash data structure, making the need to fix this problem of highest importance.

ICAST: int value converted to long and used as absolute time (ICAST_INT_2_LONG_AS_INSTANT)

This code converts a 32-bit int value to a 64-bit long value, and then passes that value for a method parameter that requires an absolute time value. An absolute time value is the number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT. For example, the following method, intended to convert seconds since the epoch into a Date, is badly broken:

Date getDate(int seconds) { return new Date(seconds * 1000); }

The multiplication is done using 32-bit arithmetic, and then converted to a 64-bit value. When a 32-bit value is converted to 64-bits and used to express an absolute time value, only dates in December 1969 and January 1970 can be represented.

Correct implementations for the above method are:

// Fails for dates after 2037
Date getDate(int seconds) { return new Date(seconds * 1000L); }

// better, works for all dates
Date getDate(long seconds) { return new Date(seconds * 1000); }

ICAST: Valeur entière transtypée en nombre flottant passée à Math.ceil (ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL)

Ce code convertit une valeur entière en nombre flottant à double précision et passe le résultat à la méthode Math.ceil(), qui arrondit un nombre flottant à sa valeur entière immédiatement supérieure. Cette opération n'a pas de raison d'être, puisque le transtypage d'un entier en double donne un nombre sans valeur après la virgule. Il est vraissemblable que l'opération qui a créé la valeur pour la passer à Math.ceil visait l'utilisation de l'arithmétique sur un nombre flottant en double précision.

ICAST: Valeur entière transtypée en flottant puis transmise à Math.round (ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND)

Ce code converti une valeur entière en flottant simple précision puis la passe à la méthode Math.round() qui renvoi l'int ou le long le plus proche de son paramètre. Cette opération doit toujours revenir à ne rien faire, puisque le transtypage d'un entier en un flottant devrait systématiquement donner un flottant sans partie décimale. Il est probable que l'opération gérant la valeur passée à Math.round() devrait être effectuée en arithmétique flottante.

IJU: JUnit assertion in run method will not be noticed by JUnit (IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD)

A JUnit assertion is performed in a run method. Failed JUnit assertions just result in exceptions being thrown. Thus, if this exception occurs in a thread other than the thread that invokes the test method, the exception will terminate the thread but not result in the test failing.

IJU: TestCase declares a bad suite method (IJU_BAD_SUITE_METHOD)

Class is a JUnit TestCase and defines a suite() method. However, the suite method needs to be declared as either

public static junit.framework.Test suite()

public static junit.framework.TestSuite suite()

IJU: TestCase sans tests (IJU_NO_TESTS)

La classe JUnit TestCase n'implémente aucune méthode de test.

IJU: Une classe dérivant de TestCase implémente setUp() sans appeler super.setUp() (IJU_SETUP_NO_SUPER)

La classe dérive de la classe TestCase de JUnit est implémente la méthode setUp(). La méthode setUp() devrait appeler super.setUp(), mais ne le fait pas.

IJU: Une classe dérivant de TestCase implémente une méthode suite() non statique (IJU_SUITE_NOT_STATIC)

La classe dérive de TestCase de JUnit et implémente une méthode suite(). La méthode suite() devrait-être déclarée comme étant static, ce qui n'est pas fait.

IJU: Une classe dérivant de TestCase implémente tearDown() sans appeler super.tearDown() (IJU_TEARDOWN_NO_SUPER)

La classe dérive de la classe TestCase de JUnit et implémente la méthode tearDown(). La méthode tearDown() devrait appeler super.tearDown(), mais ne le fait pas.

IL: Un conteneur est ajouté à lui-même (IL_CONTAINER_ADDED_TO_ITSELF)

Un conteneur est ajouté à lui-même. Il en résulte que le calcul du code de hachage de cet ensemble provequera une StackOverflowEception.

IL: Boucle apparemment inifinie (IL_INFINITE_LOOP)

Cette boucle ne semble pas avoir un moyen de se terminer (autrement que, peut être, en déclenchant une exception).

IL: Boucle récursive infinie (IL_INFINITE_RECURSIVE_LOOP)

Cette méthode s'appelle elle-même sans condition. Cela semble indiquer une boucle récursive infinie qui se terminera sur un débordement de la pile.

IM: Multiplication d'un entier avec le résulat entier d'un modulo (IM_MULTIPLYING_RESULT_OF_IREM)

Ce code mutilplie le résultat d'un modulo avec une constante entière. Faîtes attention à la précédence des opérateurs. Par exemple, i % 60 * 1000 correspond à (i % 60) * 1000, non à i % (60 * 1000).

INT: Bad comparison of int value with long constant (INT_BAD_COMPARISON_WITH_INT_VALUE)

This code compares an int value with a long constant that is outside the range of values that can be represented as an int value. This comparison is vacuous and possibily to be incorrect.

INT: Bad comparison of nonnegative value with negative constant or zero (INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE)

This code compares a value that is guaranteed to be non-negative with a negative constant or zero.

INT: Bad comparison of signed byte (INT_BAD_COMPARISON_WITH_SIGNED_BYTE)

Signed bytes can only have a value in the range -128 to 127. Comparing a signed byte with a value outside that range is vacuous and likely to be incorrect. To convert a signed byte b to an unsigned value in the range 0..255, use 0xff & b

IO: Doomed attempt to append to an object output stream (IO_APPENDING_TO_OBJECT_OUTPUT_STREAM)

This code opens a file in append mode and then wraps the result in an object output stream. This won't allow you to append to an existing object output stream stored in a file. If you want to be able to append to an object output stream, you need to keep the object output stream open.

The only situation in which opening a file in append mode and the writing an object output stream could work is if on reading the file you plan to open it in random access mode and seek to the byte offset where the append started.

TODO: example.

IP: Un paramètre est ré-écrit avant d'être utilisé (IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN)

La valeur initiale de ce paramètre est ignorée, et le paramètre est écrasé. Ceci indique généralement une erreur provenant de la croyance infondée qu'une écriture sur ce paramètre sera transmise à l'appelant.

MF: La classe définit un champ qui masque un champ d'une classe mère (MF_CLASS_MASKS_FIELD)

Cette classe définit un champ avec le même nom qu'un champ visible d'instance d'une classe mère. C'est ambigu et peut entraîner une erreur si des méthodes mettent à jour ou accèdent à un des champs alors qu'elles souhaitaient utiliser l'autre.

MF: La méthode définit une variable qui masque un champ (MF_METHOD_MASKS_FIELD)

Cette méthode définit une variable locale ayant le même nom qu'un champ de la classe ou d'une classe mère. Ceci peut pousser la méthode à lire une valeur non initialisée dans le champs, à le laisser non initialisé ou les deux.

NP: Déréférencement d'un pointeur null dans la méthode (NP_ALWAYS_NULL)

Un pointeur à null est déréférencé ici. Ceci va mener à une NullPointerException quand le code sera exécuté.

NP: Déréférencement d'un pointeur null dans le chemin d'exception d'une méthode (NP_ALWAYS_NULL_EXCEPTION)

Un pointeur à null dans le chemin d'exception est déréférencé ici. Cela va mener à une NullPointerException quand le code sera exécuté. Notez que puisque FindBugs ne détecte pas les chemins d'exception irréalisables, il est possible que cette alarme soit injustifiée.

Notez aussi que FindBugs considère le choix par défaut d'un switch comme étant dans le chemin d'exception, puisque ce choix est souvent irréalisable.

NP: Méthode ne testant pas les paramètres à null (NP_ARGUMENT_MIGHT_BE_NULL)

Un paramètre de cette méthode a été identifié comme une valeur pouvant être à null, mais qui est déréférencée sans test de nullité.

NP: close() invoked on a value that is always null (NP_CLOSING_NULL)

close() is being invoked on a value that is always null. If this statement is executed, a null pointer exception will occur. But the big risk here you never close something that should be closed.

NP: Null déréférencé (NP_GUARANTEED_DEREF)

Cette méthode contient une valeur à null qui est déréférencée (sauf dans les chemins impliquant une RuntimeException).

NP: Value is null and guaranteed to be dereferenced on exception path (NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH)

There is a statement or branch on an exception path that if executed guarantees that a value is null at this point, and that value that is guaranteed to be dereferenced (except on forward paths involving runtime exceptions).

NP: Non-null field is not initialized (NP_NONNULL_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR)

The field is marked as non-null, but isn't written to by the constructor. The field might be initialized elsewhere during constructor, or might always be initialized before use.

NP: Appel de méthode transmettant null à un paramètre déclaré @NonNull (NP_NONNULL_PARAM_VIOLATION)

Cette méthode passe une valeur à null en paramètre d'une méthode qui a déclaré ce paramètre comme @NonNull.

Notez que la méthode avec l'annotation @NonNull peut être dans une sous-classe de l'objet appelé.

NP: Méthode renvoyer null mais déclarée @NonNull (NP_NONNULL_RETURN_VIOLATION)

Cette méthode peut renvoyer une valeur à null alors que cette méthode (ou une méthode dérivée d'une de ses classes mère) est déclarée comme renvoyant @NonNull.

NP: A known null value is checked to see if it is an instance of a type (NP_NULL_INSTANCEOF)

This instanceof test will always return false, since the value being checked is guaranteed to be null. Although this is safe, make sure it isn't an indication of some misunderstanding or some other logic error.

NP: Possible déréférencement d'un pointeur null dans une méthode (NP_NULL_ON_SOME_PATH)

Une valeur par référence déréférencée ici peut-être à null à l'exécution. Cela peut conduire à une NullPointerException quand le code est exécuté.

NP: Possible déréférencement d'un pointeur null dans le chemin d'exception d'une méthode (NP_NULL_ON_SOME_PATH_EXCEPTION)

Une valeur par référence qui est à null dans un des chemins d'exception est déréférencée ici. Ceci peut conduire à une NullPointerException à l'exécution du code. Notez que comme FindBugs ne repère pas les chemins d'exception irréalisables, il est possible que cette alarme soit injustifiée.

Notez également que FindBugs considère le cas par défaut d'un switch comme faisant partie du chemin d'exception puisque ce cas est souvent inattendu.

NP: Méthode passant null à un paramètre déréférencé inconditionnellement (NP_NULL_PARAM_DEREF)

Cet appel de méthode envoie null à une méthode qui peut déréférencer ce paramètre de façon inconditionnelle.

NP: Appel de méthode passant null à un paramètre déréférencé inconditionnellement (NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS)

Une valeur pouvant être à null est passée lors d'un appel alors que toutes les méthodes cibles possibles le déréférence inconditionnellement. Cela a de fortes chances de provoquer une NullPointerException.

NP: Appel à une méthode non virtuelle passant null à un paramètre déréférencé de façon inconditionnelle (NP_NULL_PARAM_DEREF_NONVIRTUAL)

Une valeur pouvant être à null est passée à une méthode qui déréférence ce paramètre de façon inconditionnelle. Cela peut se terminer en NullPointerException.

NP: Method with Optional return type returns explicit null (NP_OPTIONAL_RETURN_NULL)

The usage of Optional return type (java.util.Optional or com.google.common.base.Optiona) always mean that explicit null returns were not desired by design. Returning a null value in such case is a contract violation and will most likely break clients code.

NP: Stocke une valeur null dans un champ annoté NonNull (NP_STORE_INTO_NONNULL_FIELD)

Une valeur qui pourrait être à null est stockée dans un champ qui a été annoté comme NonNull.

NP: Lecture d'un champ jamais écrit (NP_UNWRITTEN_FIELD)

Le programme déréférence un champ qui ne semble jamais alimenté par une valeur non nulle. Déréférencer cette valeur provoquera une NullPointerException.

Nm: La classe définit equal() ; ne devrait-ce pas être equals() ? (NM_BAD_EQUAL)

Cette classe définit une méthode equal(Object). Cette méthode ne surcharge pas la méthode equals(Object) de java.lang.Object, surchage qui était pourtant sans doute le but visé.

Nm: La classe définit hashcode() ; ne devrait-ce pas être hashCode() ? (NM_LCASE_HASHCODE)

Cette classe définit une méthode nommée hashcode(). Cette méthode ne surcharge pas la méthode hashCode() de java.lang.Object, surchage qui était pourtant sans doute le but visé.

Nm: La classe définit tostring() ; ne devrait-ce pas être toString() ? (NM_LCASE_TOSTRING)

Cette classe définit une méthode appelée tostring(). Cette méthode ne surcharge pas la méthode toString() de java.lang.Object, surchage qui était pourtant sans doute le but visé.

Nm: Confusion apparente entre une méthode et un constructeur (NM_METHOD_CONSTRUCTOR_CONFUSION)

Cette méthode a le même nom que la classe dans laquelle elle est déclarée. Il est probable qu'elle devait être un constructeur. Si c'est bien le cas, retirez la déclaration d'une valeur de retour.

Nm: Noms de méthodes très ambigus (NM_VERY_CONFUSING)

Les méthodes indiquées ont des noms qui ne diffèrent que par les majuscules. C'est d'autant plus ambigu que les classes comportant ces méthodes sont liées par héritage.

Nm: Method doesn't override method in superclass due to wrong package for parameter (NM_WRONG_PACKAGE)

The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match the type of the corresponding parameter in the superclass. For example, if you have:

import alpha.Foo;
public class A {
  public int f(Foo x) { return 17; }
}
----
import beta.Foo;
public class B extends A {
  public int f(Foo x) { return 42; }
}

The f(Foo) method defined in class B doesn't override the f(Foo) method defined in class A, because the argument types are Foo's from different packages.

QBA: Méthode assignant une valeur boléenne fixe dans une expression booléenne (QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT)

Cette méthode assigne une valeur booléenne fixe (true ou false) à une variable booléenne dans une expression if ou while. Il est probable que le but était d'effectuer une comparaison booléenne utilisant == et non pas une affectation avec =.

RANGE: Array index is out of bounds (RANGE_ARRAY_INDEX)

Array operation is performed, but array index is out of bounds, which will result in ArrayIndexOutOfBoundsException at runtime.

RANGE: Array length is out of bounds (RANGE_ARRAY_LENGTH)

Method is called with array parameter and length parameter, but the length is out of bounds. This will result in IndexOutOfBoundsException at runtime.

RANGE: Array offset is out of bounds (RANGE_ARRAY_OFFSET)

Method is called with array parameter and offset parameter, but the offset is out of bounds. This will result in IndexOutOfBoundsException at runtime.

RANGE: String index is out of bounds (RANGE_STRING_INDEX)

String method is called and specified string index is out of bounds. This will result in StringIndexOutOfBoundsException at runtime.

RC: Comparaison de références suspecte (RC_REF_COMPARISON)

Cette méthode compare deux références avec l'opérateur == ou !=, alors que la façon correcte de comparer les instances de ce type est généralement d'utiliser la méthode equals(). Des exemples de classes qui ne doivent généralement pas être comparées par référence sont java.lang.Integer, java.lang.Float, etc...

RCN: Test de nullité d'une valeur préalablement déréférencée (RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE)

Une valeur est testée ici pour savoir si elle est à null alors que cette valeur ne peut pas être à null puisqu'elle a été déréférencée et qu'une NullPointerException se serait alors produite à ce moment. Ce code est en contradiction avec le déréférencement préalable au sujet de la capacité de cette valeur d'être à null. Soit le test est redondant, soit le déréférencement préalable est erroné.

RE: Syntaxe d'expression régulière invalide (RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION)

Le code utilise une expression régulière qui est invalide selon la syntaxe des expressions régulières. Lors de l'exécution, une exception PatternSyntaxException sera lancée.

RE: File.separator used for regular expression (RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION)

The code here uses File.separator where a regular expression is required. This will fail on Windows platforms, where the File.separator is a backslash, which is interpreted in a regular expression as an escape character. Amoung other options, you can just use File.separatorChar=='\\' ? "\\\\" : File.separator instead of File.separator

RE: "." utilisé dans une expression régulière (RE_POSSIBLE_UNINTENDED_PATTERN)

Une fonction String attendant une expression régulière reçoit "." en paramètre. Est-ce voulu ? Par exemple, s.replaceAll(".", "/") renverra une chaine dont chaque caractère aura été remplacé par le caractère '/'.

RV: Les valeurs aléatoires entre 0 et 1 sont réduites à l'entier 0 (RV_01_TO_INT)

Une valeur aléatoire comprise entre 0 et 1 est réduite à la valeur entière 0. Vous souhaitez probablement multiplier cette valeur aléatoire par quelque chose avant de la réduire à un entier, ou utiliser la méthode Random.nextInt(n).

RV: Bad attempt to compute absolute value of signed 32-bit hashcode (RV_ABSOLUTE_VALUE_OF_HASHCODE)

This code generates a hashcode and then computes the absolute value of that hashcode. If the hashcode is Integer.MIN_VALUE, then the result will be negative as well (since Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE).

One out of 2^32 strings have a hashCode of Integer.MIN_VALUE, including "polygenelubricants" "GydZG_" and ""DESIGNING WORKHOUSES".

RV: Bad attempt to compute absolute value of signed random integer (RV_ABSOLUTE_VALUE_OF_RANDOM_INT)

This code generates a random signed integer and then computes the absolute value of that random integer. If the number returned by the random number generator is Integer.MIN_VALUE, then the result will be negative as well (since Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE). (Same problem arised for long values as well).

RV: Code checks for specific values returned by compareTo (RV_CHECK_COMPARETO_FOR_SPECIFIC_RETURN_VALUE)

This code invoked a compareTo or compare method, and checks to see if the return value is a specific value, such as 1 or -1. When invoking these methods, you should only check the sign of the result, not for any specific non-zero value. While many or most compareTo and compare methods only return -1, 0 or 1, some of them will return other values.

RV: Exception created and dropped rather than thrown (RV_EXCEPTION_NOT_THROWN)

This code creates an exception (or error) object, but doesn't do anything with it. For example, something like

if (x < 0)
  new IllegalArgumentException("x must be nonnegative");

It was probably the intent of the programmer to throw the created exception:

if (x < 0)
  throw new IllegalArgumentException("x must be nonnegative");

RV: La méthode ignore une valeur de retour (RV_RETURN_VALUE_IGNORED)

La valeur renvoyée par cette méthode devrait-être vérifiée. Une cause habituelle de cette alarme est d'invoquer une méthode sur un objet constant en pensant que cela modifiera l'objet. Par exemple :

String dateString = getHeaderField(name);
dateString.trim();

Le programmeur semble croire que la méthode trim() mettra à jour l'objet String référencé par dateString. Mais, les objets String étant constants, la fonction renvoi une nouvelle valeur qui est ici ignorée. Le code devrait être corrigé en :

String dateString = getHeaderField(name);
dateString = dateString.trim();

RpC: Repeated conditional tests (RpC_REPEATED_CONDITIONAL_TEST)

The code contains a conditional test is performed twice, one right after the other (e.g., x == 0 || x == 0). Perhaps the second occurrence is intended to be something else (e.g., x == 0 || y == 0).

SA: Auto-alimentation d'un champs (SA_FIELD_SELF_ASSIGNMENT)

Cette méthode contient un champ s'auto-alimentant; par exemple :

int x;
public void foo() {
  x = x;
}

De telles affectations sont inutiles et peuvent indiquer une faute de frappe ou une erreur logique.

SA: Self comparison of field with itself (SA_FIELD_SELF_COMPARISON)

This method compares a field with itself, and may indicate a typo or a logic error. Make sure that you are comparing the right things.

SA: Nonsensical self computation involving a field (e.g., x & x) (SA_FIELD_SELF_COMPUTATION)

This method performs a nonsensical computation of a field with another reference to the same field (e.g., x&x or x-x). Because of the nature of the computation, this operation doesn't seem to make sense, and may indicate a typo or a logic error. Double check the computation.

SA: Self assignment of local rather than assignment to field (SA_LOCAL_SELF_ASSIGNMENT_INSTEAD_OF_FIELD)

This method contains a self assignment of a local variable, and there is a field with an identical name. assignment appears to have been ; e.g.

  int foo;
  public void setFoo(int foo) {
    foo = foo;
  }

The assignment is useless. Did you mean to assign to the field instead?

SA: Self comparison of value with itself (SA_LOCAL_SELF_COMPARISON)

This method compares a local variable with itself, and may indicate a typo or a logic error. Make sure that you are comparing the right things.

SA: Nonsensical self computation involving a variable (e.g., x & x) (SA_LOCAL_SELF_COMPUTATION)

This method performs a nonsensical computation of a local variable with another reference to the same variable (e.g., x&x or x-x). Because of the nature of the computation, this operation doesn't seem to make sense, and may indicate a typo or a logic error. Double check the computation.

SF: Dead store due to switch statement fall through (SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH)

A value stored in the previous switch case is overwritten here due to a switch fall through. It is likely that you forgot to put a break or return at the end of the previous case.

SF: Dead store due to switch statement fall through to throw (SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH_TO_THROW)

A value stored in the previous switch case is ignored here due to a switch fall through to a place where an exception is thrown. It is likely that you forgot to put a break or return at the end of the previous case.

SIC: Deadly embrace of non-static inner class and thread local (SIC_THREADLOCAL_DEADLY_EMBRACE)

This class is an inner class, but should probably be a static inner class. As it is, there is a serious danger of a deadly embrace between the inner class and the thread local in the outer class. Because the inner class isn't static, it retains a reference to the outer class. If the thread local contains a reference to an instance of the inner class, the inner and outer instance will both be reachable and not eligible for garbage collection.

SIO: Vérification de type inutile avec l'opérateur instanceof (SIO_SUPERFLUOUS_INSTANCEOF)

Vérification de type effectuée avec l'opérateur instanceof alors que cela pourrait-être déterminé statiquement.

SQL: Méthode essayant au paramêtre d'indice 0 d'un PreparedStatement (SQL_BAD_PREPARED_STATEMENT_ACCESS)

Un appel à une méthode setXXX d'un PreparedStatement est réalisé sur l'indice 0. Puisque les indices des paramêtres d'un PreparedStatement commencent à 1, c'est toujours une erreur.

SQL: Méthode essayant d'accèder à un champ de ResultSet d'indice 0 (SQL_BAD_RESULTSET_ACCESS)

Un appel à une méthode getXXX ou updateXXX d'un ResultSet est réalisé pour l'indice 0. Puisque les indices de ResultSet commencent à 1, c'est toujours une erreur.

STI: Utilisation superflue d'un appel à currentThread() pour appeler interrupted() (STI_INTERRUPTED_ON_CURRENTTHREAD)

Cette méthode invoque Thread.currentThread() juste pour appeler la méthode interrupted(). Comme interrupted() est une méthode statique, il est plus simple et facile d'utiliser Thread.interrupted().

STI: Thread.interrupted() appelée par erreur sur un objet Thread arbitraire (STI_INTERRUPTED_ON_UNKNOWNTHREAD)

Cette méthode invoque Thread.interrupted() sur un objet Thread qui n'est pas le thread actif. Pusique la méthode interrupted() est statique, la méthode interrupted() sera appelée sur un objet différent de celui auquel l'auteur du code pensait.

Se: Méthode devant être privée pour que la sérialisation fonctionne (SE_METHOD_MUST_BE_PRIVATE)

Cette classe implémente l'interface Serializable et défini une méthode pour personnaliser la sérialisation/désérialisation. Mais cette méthode n'étant pas déclarée privée elle sera ignorée silencieusement par les API de sérialisation/désérialisation.

Se: The readResolve method must not be declared as a static method. (SE_READ_RESOLVE_IS_STATIC)

In order for the readResolve method to be recognized by the serialization mechanism, it must not be declared as a static method.

TQ: Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required (TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED)

A value specified as carrying a type qualifier annotation is consumed in a location or locations requiring that the value not carry that annotation.

More precisely, a value annotated with a type qualifier specifying when=ALWAYS is guaranteed to reach a use or uses where the same type qualifier specifies when=NEVER.

For example, say that @NonNegative is a nickname for the type qualifier annotation @Negative(when=When.NEVER). The following code will generate this warning because the return statement requires a @NonNegative value, but receives one that is marked as @Negative.

public @NonNegative Integer example(@Negative Integer value) {
    return value;
}

TQ: Comparing values with incompatible type qualifiers (TQ_COMPARING_VALUES_WITH_INCOMPATIBLE_TYPE_QUALIFIERS)

A value specified as carrying a type qualifier annotation is compared with a value that doesn't ever carry that qualifier.

More precisely, a value annotated with a type qualifier specifying when=ALWAYS is compared with a value that where the same type qualifier specifies when=NEVER.

For example, say that @NonNegative is a nickname for the type qualifier annotation @Negative(when=When.NEVER). The following code will generate this warning because the return statement requires a @NonNegative value, but receives one that is marked as @Negative.

public boolean example(@Negative Integer value1, @NonNegative Integer value2) {
    return value1.equals(value2);
}

TQ: Value that might not carry a type qualifier is always used in a way requires that type qualifier (TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK)

A value that is annotated as possibility not being an instance of the values denoted by the type qualifier, and the value is guaranteed to be used in a way that requires values denoted by that type qualifier.

TQ: Value that might carry a type qualifier is always used in a way prohibits it from having that type qualifier (TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK)

A value that is annotated as possibility being an instance of the values denoted by the type qualifier, and the value is guaranteed to be used in a way that prohibits values denoted by that type qualifier.

TQ: Value annotated as never carrying a type qualifier used where value carrying that qualifier is required (TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED)

A value specified as not carrying a type qualifier annotation is guaranteed to be consumed in a location or locations requiring that the value does carry that annotation.

More precisely, a value annotated with a type qualifier specifying when=NEVER is guaranteed to reach a use or uses where the same type qualifier specifies when=ALWAYS.

TODO: example

TQ: Value without a type qualifier used where a value is required to have that qualifier (TQ_UNKNOWN_VALUE_USED_WHERE_ALWAYS_STRICTLY_REQUIRED)

A value is being used in a way that requires the value be annotation with a type qualifier. The type qualifier is strict, so the tool rejects any values that do not have the appropriate annotation.

To coerce a value to have a strict annotation, define an identity function where the return value is annotated with the strict annotation. This is the only way to turn a non-annotated value into a value with a strict type qualifier annotation.

UMAC: Méthode non appelable définie dans une classe anonyme (UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS)

Cette classe anonyme définie une méthode qui n'est pas directement appelée et qui ne surcharge pas une méthode de la classe mère. Puisque les méthodes des autres classes ne peuvent pas directement invoquer les méthodes des classes anonymes, il apparaît que cette méthode est inaccessible. Cette méthode est probablement du code mort, mais il est aussi possible qu'elle essaye de surcharger une méthode déclarée dans la classe mère et échoue à le faire en raison d'une erreur de type ou autre.

UR: Lecture d'un champ non initialisé dans un constructeur (UR_UNINIT_READ)

Ce constructeur lit un champ qui n'a pas encore été initialisé. Une des causes les plus fréquentes est l'utilisation accidentelle par le développeur du champ au lieu d'un des paramètres du constructeur.

UR: Uninitialized read of field method called from constructor of superclass (UR_UNINIT_READ_CALLED_FROM_SUPER_CONSTRUCTOR)

This method is invoked in the constructor of of the superclass. At this point, the fields of the class have not yet initialized.

To make this more concrete, consider the following classes:

abstract class A {
  int hashCode;
  abstract Object getValue();
  A() {
    hashCode = getValue().hashCode();
    }
  }
class B extends A {
  Object value;
  B(Object v) {
    this.value = v;
    }
  Object getValue() {
    return value;
  }
  }

When a B is constructed, the constructor for the A class is invoked before the constructor for B sets value. Thus, when the constructor for A invokes getValue, an uninitialized value is read for value

USELESS_STRING: Invocation of toString on an unnamed array (DMI_INVOKING_TOSTRING_ON_ANONYMOUS_ARRAY)

The code invokes toString on an (anonymous) array. Calling toString on an array generates a fairly useless result such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.

USELESS_STRING: Invocation de toString sur un tableau (DMI_INVOKING_TOSTRING_ON_ARRAY)

Le code invoque toString sur un tableau, ce qui va générer un résultat assez inutile du genre [C@16f0472. Envisagez d'utiliser String.valueOf pour convertir un tableau en une chaine lisible contenant les valeurs du tableau. Cf Programming Puzzlers, chapitre 3, problème 12.

USELESS_STRING: Array formatted in useless way using format string (VA_FORMAT_STRING_BAD_CONVERSION_FROM_ARRAY)

One of the arguments being formatted with a format string is an array. This will be formatted using a fairly useless format, such as [I@304282, which doesn't actually show the contents of the array. Consider wrapping the array using Arrays.asList(...) before handling it off to a formatted.

UwF: Champ uniquement mis à null (UWF_NULL_FIELD)

Ce champ est uniquement alimenté par la constante null et donc toutes les lectures de ce champ renverront null. Vérifiez si c'est une erreur ou alors supprimez ce champ qui est inutile.

UwF: Champ jamais écrit (UWF_UNWRITTEN_FIELD)

Ce champ n'est jamais alimenté. Toutes les lectures vont renvoyer sa valeur par défaut. Recherchez les erreurs (devrait-il avoir été initialisé ?) ou supprimez le s'il est inutile.

VA: Tableau de primitives passé à une fonction attendant un nombre variable d'objets en argument (VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG)

Ce code envoie un tableau de primitives à une fonction qui attend un nombre variable d'objets en arguments. Ceci créé un tableau de longueur 1 pour contenir le tableau de primitives puis le passe à la fonction.

LG: Potential lost logger changes due to weak reference in OpenJDK (LG_LOST_LOGGER_DUE_TO_WEAK_REFERENCE)

OpenJDK introduces a potential incompatibility. In particular, the java.util.logging.Logger behavior has changed. Instead of using strong references, it now uses weak references internally. That's a reasonable change, but unfortunately some code relies on the old behavior - when changing logger configuration, it simply drops the logger reference. That means that the garbage collector is free to reclaim that memory, which means that the logger configuration is lost. For example, consider:

public static void initLogging() throws Exception {
 Logger logger = Logger.getLogger("edu.umd.cs");
 logger.addHandler(new FileHandler()); // call to change logger configuration
 logger.setUseParentHandlers(false); // another call to change logger configuration
}

The logger reference is lost at the end of the method (it doesn't escape the method), so if you have a garbage collection cycle just after the call to initLogging, the logger configuration is lost (because Logger only keeps weak references).

public static void main(String[] args) throws Exception {
 initLogging(); // adds a file handler to the logger
 System.gc(); // logger configuration lost
 Logger.getLogger("edu.umd.cs").info("Some message"); // this isn't logged to the file as expected
}

Ulf Ochsenfahrt and Eric Fellheimer

OBL: Method may fail to clean up stream or resource (OBL_UNSATISFIED_OBLIGATION)

This method may fail to clean up (close, dispose of) a stream, database object, or other resource requiring an explicit cleanup operation.

In general, if a method opens a stream or other resource, the method should use a try/finally block to ensure that the stream or resource is cleaned up before the method returns.

This bug pattern is essentially the same as the OS_OPEN_STREAM and ODR_OPEN_DATABASE_RESOURCE bug patterns, but is based on a different (and hopefully better) static analysis technique. We are interested is getting feedback about the usefulness of this bug pattern. To send feedback, either:

• send email to findbugs@cs.umd.edu
• file a bug report: http://findbugs.sourceforge.net/reportingBugs.html

In particular, the false-positive suppression heuristics for this bug pattern have not been extensively tuned, so reports about false positives are helpful to us.

See Weimer and Necula, Finding and Preventing Run-Time Error Handling Mistakes, for a description of the analysis technique.

OBL: Method may fail to clean up stream or resource on checked exception (OBL_UNSATISFIED_OBLIGATION_EXCEPTION_EDGE)

This method may fail to clean up (close, dispose of) a stream, database object, or other resource requiring an explicit cleanup operation.

In general, if a method opens a stream or other resource, the method should use a try/finally block to ensure that the stream or resource is cleaned up before the method returns.

This bug pattern is essentially the same as the OS_OPEN_STREAM and ODR_OPEN_DATABASE_RESOURCE bug patterns, but is based on a different (and hopefully better) static analysis technique. We are interested is getting feedback about the usefulness of this bug pattern. To send feedback, either:

• send email to findbugs@cs.umd.edu
• file a bug report: http://findbugs.sourceforge.net/reportingBugs.html

In particular, the false-positive suppression heuristics for this bug pattern have not been extensively tuned, so reports about false positives are helpful to us.

See Weimer and Necula, Finding and Preventing Run-Time Error Handling Mistakes, for a description of the analysis technique.

Dm: La méthode appelle les String.toUpperCase() ou String.toLowerCase ; utilisez plutôt la version paramètrée par une Locale (DM_CONVERT_CASE)

Une chaîne est mise en majuscules ou minuscules en fonction de jeu de caractères par défaut de la machine. Ceci peut entraîner des conversions erronées sur les caractères internationaux. Utilisez String.toUpperCase(Locale l) ou String.toLowerCase(Locale l) à la place.

Dm: Reliance on default encoding (DM_DEFAULT_ENCODING)

Found a call to a method which will perform a byte to String (or String to byte) conversion, and will assume that the default platform encoding is suitable. This will cause the application behaviour to vary between platforms. Use an alternative API and specify a charset name or Charset object explicitly.

DP: Les chargeurs de classes ne doivent être créés qu'à partir de block doPrivileged (DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED)

Ce code créé un chargeur de classes, ce qui nécessite un test de sécurité. Même si ce code possède des droits suffisants, la création du chargeur de classes devrait être effectuée dans un block doPrivileged au cas ou il serait appelé par du code ne possédant pas les droits requis.

DP: Méthode invoquée alors qu'elle ne devrait l'être qu'à partir d'un block doPrivileged (DP_DO_INSIDE_DO_PRIVILEGED)

Ce code invoque une méthode qui nécessite un test de sécurité sur les permissions. Si ce code, bien qu'ayant les droits suffisants, peut être invoqué par du code n'ayant pas les droits requis l'appel doit alors être effectué à l'intérieur d'un block doPrivileged.

EI: Une méthode peut exposer sa représentation interne en renvoyant une référence à un objet modifiable (EI_EXPOSE_REP)

Renvoyer une référence à un objet modifiable stocké dans les champs d'un objet expose la représentation interne de l'objet. Si des instances sont accédées par du code non fiable, et que des modifications non vérifiées peuvent compromettre la sécurité ou d'autres propriétés importantes, vous devez faire autre chose. Renvoyer une nouvelle copie de l'objet est une meilleur approche dans de nombreuses situations.

EI2: Une méthode expose sa représentation interne en incorporant une référence à un objet modifiable (EI_EXPOSE_REP2)

Ce code stocke une référence à un objet externe modifiable dans la représentation interne de l'objet. Si des instances sont accédées par du code non fiable, et que des modifications non vérifiées peuvent compromettre la sécurité ou d'autres propriétés importantes, vous devez faire autre chose. Stocker une copie de l'objet est une meilleur approche dans de nombreuses situations.

FI: Un finaliseur devrait être protégé, pas public (FI_PUBLIC_SHOULD_BE_PROTECTED)

La méthode finalize() d'une classe devrait avoir un accès protégé, pas public.

MS: Une méthode peut exposer un état interne statique en stockant un objet modifiable dans un champs statique (EI_EXPOSE_STATIC_REP2)

Ce code stocke une référence à un objet modifiable externe dans un champs statique. Si des modifications non vérifiées de l'objet modifiable peuvent compromettre la sécurité ou d'autres propriétés importantes, vous devez faire autre chose. Stocker une copie de l'objet est souvent une meilleur approche.

MS: Un champ n'est pas final et ne peut pas être protégé face à du code malveillant (MS_CANNOT_BE_FINAL)

Un champ statique modifiable peut-être modifié par accident ou par du code malveillant. Malheureusement, la façon dont ce champ est utilisé ne permet une correction aisée de ce problème.

MS: Une méthode statique publique risque d'exposer une représentation interne en renvoyant un tableau (MS_EXPOSE_REP)

Une méthode statique publique renvoit une référence à un tableau faisant partie de l'état statique de la classe. Tout code appelant cette méthode peut librement modifier le tableau sous-jacent. Une correction possible serait de renvoyer une copie du tableau.

MS: Le champ devrait être à la fois final et package protected (MS_FINAL_PKGPROTECT)

Un champ statique modifiable peut-être changé par accident ou par du code malveillant d'un autre paquetage. Le champ devrait être package protected et/ou final pour éviter cette vulnérabilité.

MS: Un champ est un tableau modifiable (MS_MUTABLE_ARRAY)

Le champ est une référence final static à un tableau et peut-être modifié par accident ou par du code malveillant d'un autre paquetage. Ce code peut librement modifier le contenu du tableau.

MS: Field is a mutable collection (MS_MUTABLE_COLLECTION)

A mutable collection instance is assigned to a final static field, thus can be changed by malicious code or by accident from another package. Consider wrapping this field into Collections.unmodifiableSet/List/Map/etc. to avoid this vulnerability.

MS: Field is a mutable collection which should be package protected (MS_MUTABLE_COLLECTION_PKGPROTECT)

A mutable collection instance is assigned to a final static field, thus can be changed by malicious code or by accident from another package. The field could be made package protected to avoid this vulnerability. Alternatively you may wrap this field into Collections.unmodifiableSet/List/Map/etc. to avoid this vulnerability.

MS: Un champ modifiable est une Hashtable (MS_MUTABLE_HASHTABLE)

Le champ est une référence final static à une Hashtable et peut-être modifié par accident ou par du code malveillant d'un autre paquetage. Ce code peut librement modifier le contenu de la Hashtable.

MS: Le champ devrait être sorti de l'interface et mis en package protected (MS_OOI_PKGPROTECT)

Un champ final static défini dans une interface référence un objet modifiable tel qu'un tableau ou une table de hachage. Cet objet pourrait être modifié par accident ou par du code sournois d'un autre paquetage. Pour résoudre cela et éviter cette vulnérabilité, le champ doit être intégré dans une classe et sa visibilité modifiée en package protected.

MS: Un champ devrait être package protected (MS_PKGPROTECT)

Un champ statique modifiable peut-être changé par accident ou par du code malveillant d'un autre paquetage. Le champ devrait être package protected pour éviter cette vulnérabilité.

MS: Un champ n'est pas final alors qu'il devrait l'être (MS_SHOULD_BE_FINAL)

Un champ statique modifiable peut-être changé par accident ou par du code malveillant d'un autre paquetage. Le champ devrait être final pour éviter cette vulnérabilité.

MS: Field isn't final but should be refactored to be so (MS_SHOULD_BE_REFACTORED_TO_BE_FINAL)

This static field public but not final, and could be changed by malicious code or by accident from another package. The field could be made final to avoid this vulnerability. However, the static initializer contains more than one write to the field, so doing so will require some refactoring.

AT: Sequence of calls to concurrent abstraction may not be atomic (AT_OPERATION_SEQUENCE_ON_CONCURRENT_ABSTRACTION)

This code contains a sequence of calls to a concurrent abstraction (such as a concurrent hash map). These calls will not be executed atomically.

DC: Possible double vérification d'un champ (DC_DOUBLECHECK)

Cette méthode contient peut-être une instance de verrou par double vérification. Cet idiome n'est pas correct vis-à-vis de la sémantique du modèle de mémoire Java. Pour plus d'informations, cf. la page http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html.

DC: Possible exposure of partially initialized object (DC_PARTIALLY_CONSTRUCTED)

Looks like this method uses lazy field initialization with double-checked locking. While the field is correctly declared as volatile, it's possible that the internal structure of the object is changed after the field assignment, thus another thread may see the partially initialized object.

To fix this problem consider storing the object into the local variable first and save it to the volatile field only after it's fully constructed.

DL: Synchronization on Boolean (DL_SYNCHRONIZATION_ON_BOOLEAN)

The code synchronizes on a boxed primitive constant, such as an Boolean.

private static Boolean inited = Boolean.FALSE;
...
  synchronized(inited) {
    if (!inited) {
       init();
       inited = Boolean.TRUE;
       }
     }
...

Since there normally exist only two Boolean objects, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock

See CERT CON08-J. Do not synchronize on objects that may be reused for more information.

DL: Synchronization on boxed primitive (DL_SYNCHRONIZATION_ON_BOXED_PRIMITIVE)

The code synchronizes on a boxed primitive constant, such as an Integer.

private static Integer count = 0;
...
  synchronized(count) {
     count++;
     }
...

Since Integer objects can be cached and shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock

See CERT CON08-J. Do not synchronize on objects that may be reused for more information.

DL: Synchronization on interned String (DL_SYNCHRONIZATION_ON_SHARED_CONSTANT)

The code synchronizes on interned String.

private static String LOCK = "LOCK";
...
  synchronized(LOCK) { ...}
...

Constant Strings are interned and shared across all other classes loaded by the JVM. Thus, this could is locking on something that other code might also be locking. This could result in very strange and hard to diagnose blocking and deadlock behavior. See http://www.javalobby.org/java/forums/t96352.html and http://jira.codehaus.org/browse/JETTY-352.

See CERT CON08-J. Do not synchronize on objects that may be reused for more information.

DL: Synchronization on boxed primitive values (DL_SYNCHRONIZATION_ON_UNSHARED_BOXED_PRIMITIVE)

The code synchronizes on an apparently unshared boxed primitive, such as an Integer.

private static final Integer fileLock = new Integer(1);
...
  synchronized(fileLock) {
     .. do something ..
     }
...

It would be much better, in this code, to redeclare fileLock as

private static final Object fileLock = new Object();

The existing code might be OK, but it is confusing and a future refactoring, such as the "Remove Boxing" refactoring in IntelliJ, might replace this with the use of an interned Integer object shared throughout the JVM, leading to very confusing behavior and potential deadlock.

Dm: Wait() appelé sur une Condition (DM_MONITOR_WAIT_ON_CONDITION)

Cette méthode appelle wait() sur un objet java.util.concurrent.locks.Condition. L'attente d'une Condition devrait être faite en utilisant l'une des méthodes await() définies dans l'interface Condition.

Dm: Thread créé avec la méthode run vide par défaut (DM_USELESS_THREAD)

Cette méthode crée un thread sans spécifier de méthode run, soit par dérivation de la classe Thread, soit en transmettant un objet Runnable. Ce thread ne fait donc rien sauf perdre du temps.

ESync: Bloc synchronisé vide (ESync_EMPTY_SYNC)

Présence d'un bloc synchronisé vide:

synchronized() {}

L'utilisation de blocs synchronisés vides est bien plus subtile et dure à réaliser correctement que bien des gens ne le reconnaissent, et de plus ne correspond que rarement à la meilleure des solutions.

IS: Synchronisation incohérente (IS2_INCONSISTENT_SYNC)

Les champs de cette classe semblent être accédés de façon incohérente vis-à-vis de la synchronisation. Le détecteur de bogue juge que :

1. la classe contient un mélange d'accès verrouillés et non verrouillés,
2. au moins un des accès verrouillés est effectué par une des propres méthodes de la classe,
3. le nombre d'accès (lectures et écritures) non synchronisés ne représente pas plus d'un tiers de tous les accès, avec plus de deux fois plus d'écritures que de lectures.

Un bogue typique déclenchant ce détecteur est l'oubli de la synchronisation sur l'une des méthodes d'une classe qui essaye d'être sûre vis-à-vis des threads.

Vous pouvez sélectionner les noeuds nommés "Accès non synchronisés" pour avoir la position exacte dans le code où le détecteur pense qu'un champ est accédé sans synchronisation.

Notez qu'il y a diverses sources d'inexactitude dans ce détecteur ; par exemple, le détecteur ne peut pas repérer statiquement toutes les situations dans lesquelles un verrou est obtenu. En fait, même lorsque le détecteur repère effectivement des accès avec et sans verrou, le code concerné peut quand même être correct.

Cette description se réfère à la version "IS2" du détecteur, qui est plus précise pour détecter les accès avec et sans verrous que l'ancien détecteur "IS".

IS: Champ non protégé contre les accès concurrents (IS_FIELD_NOT_GUARDED)

Ce champ est annoté avec net.jcip.annotations.GuardedBy, mais peut être utilisé d'une façon qui contredit l'annotation.

JLM: Synchronisation effectuée sur un Lock java.util.concurrent (JLM_JSR166_LOCK_MONITORENTER)

Cette méthode se synchronise au moyen d'une implémentation de java.util.concurrent.locks.Lock. Vous devriez plutôt utiliser les méthodes lock() et unlock().

JLM: Synchronization performed on util.concurrent instance (JLM_JSR166_UTILCONCURRENT_MONITORENTER)

This method performs synchronization an object that is an instance of a class from the java.util.concurrent package (or its subclasses). Instances of these classes have their own concurrency control mechanisms that are orthogonal to the synchronization provided by the Java keyword synchronized. For example, synchronizing on an AtomicBoolean will not prevent other threads from modifying the AtomicBoolean.

Such code may be correct, but should be carefully reviewed and documented, and may confuse people who have to maintain the code at a later date.

JLM: Using monitor style wait methods on util.concurrent abstraction (JML_JSR166_CALLING_WAIT_RATHER_THAN_AWAIT)

This method calls wait(), notify() or notifyAll()() on an object that also provides an await(), signal(), signalAll() method (such as util.concurrent Condition objects). This probably isn't what you want, and even if you do want it, you should consider changing your design, as other developers will find it exceptionally confusing.

LI: Initialisation paresseuse incorrecte d'un champ statique (LI_LAZY_INIT_STATIC)

Cette méthode contient une initialisation paresseuse non synchronisée d'un champ statique non volatile. Comme le compilateur ou le processeur peuvent réordonner les instructions, les threads ne sont pas certains de voir un objet complètement initialisé, si la méthode peut-être appelée par de multiples threads. Vous pouvez rendre le champs volatile pour corriger le problème. Pour plus d'informations, cf. site Web sur le modèle mémoire de Java.

LI: Incorrect lazy initialization and update of static field (LI_LAZY_INIT_UPDATE_STATIC)

This method contains an unsynchronized lazy initialization of a static field. After the field is set, the object stored into that location is further updated or accessed. The setting of the field is visible to other threads as soon as it is set. If the futher accesses in the method that set the field serve to initialize the object, then you have a very serious multithreading bug, unless something else prevents any other thread from accessing the stored object until it is fully initialized.

Even if you feel confident that the method is never called by multiple threads, it might be better to not set the static field until the value you are setting it to is fully populated/initialized.

ML: Synchronization on field in futile attempt to guard that field (ML_SYNC_ON_FIELD_TO_GUARD_CHANGING_THAT_FIELD)

This method synchronizes on a field in what appears to be an attempt to guard against simultaneous updates to that field. But guarding a field gets a lock on the referenced object, not on the field. This may not provide the mutual exclusion you need, and other threads might be obtaining locks on the referenced objects (for other purposes). An example of this pattern would be:

private Long myNtfSeqNbrCounter = new Long(0);
private Long getNotificationSequenceNumber() {
     Long result = null;
     synchronized(myNtfSeqNbrCounter) {
         result = new Long(myNtfSeqNbrCounter.longValue() + 1);
         myNtfSeqNbrCounter = new Long(result.longValue());
     }
     return result;
 }

ML: La méthode se synchronise sur un champ mis à jour (ML_SYNC_ON_UPDATED_FIELD)

Cette méthode se synchronise sur le champ modifiable d'une référence objet. Il y a peu de chances que cela ait un sens puisque les différents threads se synchroniserons par rapport à différents objets.

MSF: Mutable servlet field (MSF_MUTABLE_SERVLET_FIELD)

A web server generally only creates one instance of servlet or jsp class (i.e., treats the class as a Singleton), and will have multiple threads invoke methods on that instance to service multiple simultaneous requests. Thus, having a mutable instance field generally creates race conditions.

MWN: notify() non appareillé (MWN_MISMATCHED_NOTIFY)

Cette méthode appelle Object.notify() ou Object.notifyAll() sans détenir, visiblement, de verrou sur l'objet. Appeler notify() ou notifyAll() sans détenir de verrou entraîne le déclenchement d'une IllegalMonitorStateException.

MWN: wait() non appareillé (MWN_MISMATCHED_WAIT)

Cette méthode appelle Object.wait() sans détenir, visiblement, de verrou sur l'objet. Appeler wait() sans détenir de verrou entraîne le déclenchement d'une IllegalMonitorStateException.

NN: Appel notify() isolé dans une méthode (NN_NAKED_NOTIFY)

Un appel à notify() ou notifyAll() est effectué sans aucun changement (apparent) de l'état d'un objet modifiable. En général, appeler une méthode notify() dans un moniteur est effectué parce qu'une condition quelconque attendue par un autre thread est devenue vraie. Dans tous les cas, pour que la condition ait un sens, elle doit porter sur un objet visible des deux threads.

Ce bogue n'indique pas nécessairement une erreur puisque la modification de l'état de l'objet peut avoir eu lieu dans une méthode qui appelle la méthode contenant la notification.

NP: Synchronize and null check on the same field. (NP_SYNC_AND_NULL_CHECK_FIELD)

Since the field is synchronized on, it seems not likely to be null. If it is null and then synchronized on a NullPointerException will be thrown and the check would be pointless. Better to synchronize on another field.

No: Utilisation de notify() plutôt que notifyAll() dans une méthode (NO_NOTIFY_NOT_NOTIFYALL)

Cette méthode appelle notify() plutôt que notifyAll(). Le moniteur Java est souvent utilisé pour de multiples conditions. Appeler notify() ne réveille qu'un thread, ce qui signifie que le thread réveillé peut ne pas être celui qui attend la condition que l'appelant vient de remplir.

RS: Seule la méthode readObject() est synchronisée (RS_READOBJECT_SYNC)

Cette classe Serializable définit une méthode readObject() qui est synchronisée. Par définition, un objet créé par désérialisation n'est accessible que par un unique thread, donc il n'y a aucun intérêt à synchroniser readObject(). Si la méthode readObject() en elle-même rend l'objet visible d'un autre thread, vous avez un exemple de style de code très douteux.

RV: Return value of putIfAbsent ignored, value passed to putIfAbsent reused (RV_RETURN_VALUE_OF_PUTIFABSENT_IGNORED)

Ru: Invocation de run() sur un thread (Vouliez-vous plutôt dire start() ?) (RU_INVOKE_RUN)

Cette méthode appelle explicitement run() sur un objet. En général, les classes implémentent l'interface Runnable parce qu'elles vont avoir leur méthode run() invoquée dans un nouveau thread, auquel cas Thread.start() est la bonne méthode à appeler.

SC: Un constructeur invoque Thread.start() (SC_START_IN_CTOR)

Le constructeur lance un thread. Il y a de fortes chances que ce soit une erreur si cette classe est un jour dérivée ou étendue puisque que le thread sera alors lancé avant que le constructeur de la classe dérivée ne soit appelé.

SP: Méthode bouclant sur un champ (SP_SPIN_ON_FIELD)

Cette méthode tourne en rond sur une boucle qui lit un champ. Le compilateur est autorisé à sortir la lecture de la boucle, créant ainsi une boucle infinie. La classe devrait être modifiée afin d'être correctement synchronisée (avec des appels à wait() et notify()).

STCAL: Call to static Calendar (STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE)

Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use. The detector has found a call to an instance of Calendar that has been obtained via a static field. This looks suspicous.

For more information on this see Sun Bug #6231579 and Sun Bug #6178997.

STCAL: Call to static DateFormat (STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE)

As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use. The detector has found a call to an instance of DateFormat that has been obtained via a static field. This looks suspicous.

For more information on this see Sun Bug #6231579 and Sun Bug #6178997.

STCAL: Static Calendar field (STCAL_STATIC_CALENDAR_INSTANCE)

Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see random ArrayIndexOutOfBoundsExceptions or IndexOutOfBoundsExceptions in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate().

You may also experience serialization problems.

Using an instance field is recommended.

For more information on this see Sun Bug #6231579 and Sun Bug #6178997.

STCAL: Static DateFormat (STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE)

As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.

You may also experience serialization problems.

Using an instance field is recommended.

For more information on this see Sun Bug #6231579 and Sun Bug #6178997.

SWL: Appel de la méthode Thread.sleep() avec un verrou (SWL_SLEEP_WITH_LOCK_HELD)

Cette méthode appelle Thread.sleep() en tenant un verrou. Ceci peut résulter en de faibles performances, peu de capacité à monter en charge ou un inter-blocage puisque d'autres processus pourraient être en attente du verrou. C'est une meilleure idée d'appeler wait() sur le verrou, afin de le libérer et de permettre à d'autre processus de tourner.

TLW: wait() avec deux verrous en attente (TLW_TWO_LOCK_WAIT)

Attendre sur on moniteur alors que deux verrous sont détenus peut entraîner un blocage fatal (deadlock). Exécuter un wait() ne libère que le verrou sur l'objet accueillant le wait(), mais aucun autre verrou. Ce n'est pas obligatoirement un bogue, mais il vaut mieux examiner ça en détails.

UG: Méthode getXXX non synchronisée, méthode setXXX synchronisée (UG_SYNC_SET_UNSYNC_GET)

Cette classe contient des méthodes getXXX et setXXX similaires dont la méthode setXXX est synchronisée tandis que la méthode getXXX ne l'est pas. Ceci peut entraîner un comportement incorrect à l'exécution car l'appelant de la méthode getXXX ne verra pas obligatoirement l'objet dans un état consistant. La méthode getXXX devrait être synchronisée.

UL: La méthode ne libère pas un verrou dans tous les chemins d'exécution (UL_UNRELEASED_LOCK)

Cette méthode acquière un verrou JSR-166 (java.util.concurrent), mais ne le libère pas dans tous les chemins d'exécution. En général, l'idiome correct pour utiliser un verrou JSR-166 est :

Lock l = ...;
l.lock();
try {
    // do something
} finally {
    l.unlock();
}

UL: La méthode ne libère pas un verrou dans tous les chemins d'exception (UL_UNRELEASED_LOCK_EXCEPTION_PATH)

Cette méthode acquière un verrou JSR-166 (java.util.concurrent), mais ne le libère pas dans tous les chemins d'exception. En général, l'idiome correct pour utiliser un verrou JSR-166 est :

Lock l = ...;
l.lock();
try {
    // do something
} finally {
    l.unlock();
}

UW: Méthode contenant un wait() non conditionné (UW_UNCOND_WAIT)

Cette méthode contient un appel à java.lang.Object.wait() qui n'est pas protégé par une condition. Si la condition que la méthode essaye d'attendre a déjà été remplie, le thread risque d'attendre indéfiniment.

VO: An increment to a volatile field isn't atomic (VO_VOLATILE_INCREMENT)

This code increments a volatile field. Increments of volatile fields aren't atomic. If more than one thread is incrementing the field at the same time, increments could be lost.

VO: Une référence volatile à un tableau ne traite pas les éléments du tableau comme volatiles (VO_VOLATILE_REFERENCE_TO_ARRAY)

Ceci déclare une référence volatile à un tableau, ce qui n'est peut-être pas ce que vous voulez. Avec une référence volatile à un tableau, les lectures et écritures de la référence au tableau sont traitées comme volatiles, mais les éléments ne sont pas volatiles. Pour obtenir des éléments volatiles, vous devez utiliser l'une des classes de tableaux atomiques de java.util.concurrent (inclus dans Java 5.0).

WL: Synchronization on getClass rather than class literal (WL_USING_GETCLASS_RATHER_THAN_CLASS_LITERAL)

This instance method synchronizes on this.getClass(). If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended. For example, consider this code from java.awt.Label:

     private static final String base = "label";
     private static int nameCounter = 0;
     String constructComponentName() {
        synchronized (getClass()) {
            return base + nameCounter++;
        }
     }
     

Subclasses of Label won't synchronize on the same subclass, giving rise to a datarace. Instead, this code should be synchronizing on Label.class

     private static final String base = "label";
     private static int nameCounter = 0;
     String constructComponentName() {
        synchronized (Label.class) {
            return base + nameCounter++;
        }
     }
     

Bug pattern contributed by Jason Mehrens

WS: Seule la méthode writeObject() est synchronisée (WS_WRITEOBJECT_SYNC)

Cette classe a une méthode writeObject() qui est synchronisée ; mais aucune autre méthode de cette classe n'est synchronisée.

Wa: Condition.await() en dehors d'une boucle (WA_AWAIT_NOT_IN_LOOP)

Cette méthode contient un appel à java.util.concurrent.await() (ou une variante) qui n'est pas dans une boucle. Si cet objet est utilisé pour de multiples conditions, la condition que l'appelant espère réveiller pourra être ou ne pas être celle qui le sera effectivement.

Wa: Méthode contenant un wait() en dehors d'une boucle (WA_NOT_IN_LOOP)

Cette méthode contient un appel à java.lang.Object.wait() qui n'est pas dans une boucle. Si le moniteur est utilisé pour des conditions multiples, la condition que l'appelant attend peut ne pas être celle qui s'est réellement déclenchée.

Bx: Primitive value is boxed and then immediately unboxed (BX_BOXING_IMMEDIATELY_UNBOXED)

A primitive is boxed, and then immediately unboxed. This probably is due to a manual boxing in a place where an unboxed value is required, thus forcing the compiler to immediately undo the work of the boxing.

Bx: Primitive value is boxed then unboxed to perform primitive coercion (BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION)

A primitive boxed value constructed and then immediately converted into a different primitive type (e.g., new Double(d).intValue()). Just perform direct primitive coercion (e.g., (int) d).

Bx: Primitive value is unboxed and coerced for ternary operator (BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR)

A wrapped primitive value is unboxed and converted to another primitive type as part of the evaluation of a conditional ternary operator (the b ? e1 : e2 operator). The semantics of Java mandate that if e1 and e2 are wrapped numeric values, the values are unboxed and converted/coerced to their common type (e.g, if e1 is of type Integer and e2 is of type Float, then e1 is unboxed, converted to a floating point value, and boxed. See JLS Section 15.25.

Bx: Boxed value is unboxed and then immediately reboxed (BX_UNBOXING_IMMEDIATELY_REBOXED)

A boxed value is unboxed and then immediately reboxed.

Bx: Boxing a primitive to compare (DM_BOXED_PRIMITIVE_FOR_COMPARE)

A boxed primitive is created just to call compareTo method. It's more efficient to use static compare method (for double and float since Java 1.4, for other primitive types since Java 1.7) which works on primitives directly.

Bx: Boxing/unboxing to parse a primitive (DM_BOXED_PRIMITIVE_FOR_PARSING)

A boxed primitive is created from a String, just to extract the unboxed primitive value. It is more efficient to just call the static parseXXX method.

Bx: Méthode allouant une primitive boxed pour appeler toString (DM_BOXED_PRIMITIVE_TOSTRING)

Une primitive "boxed" est allouée juste pour appeler toString(). Il est plus efficace de simplement utiliser la forme statique de toString qui accepte la valeur primitive. Donc,

Bx: Method invokes inefficient floating-point Number constructor; use static valueOf instead (DM_FP_NUMBER_CTOR)

Using new Double(double) is guaranteed to always result in a new object whereas Double.valueOf(double) allows caching of values to be done by the compiler, class library, or JVM. Using of cached values avoids object allocation and the code will be faster.

Unless the class must be compatible with JVMs predating Java 1.5, use either autoboxing or the valueOf() method when creating instances of Double and Float.

Bx: Method invokes inefficient Number constructor; use static valueOf instead (DM_NUMBER_CTOR)

Using new Integer(int) is guaranteed to always result in a new object whereas Integer.valueOf(int) allows caching of values to be done by the compiler, class library, or JVM. Using of cached values avoids object allocation and the code will be faster.

Values between -128 and 127 are guaranteed to have corresponding cached instances and using valueOf is approximately 3.5 times faster than using constructor. For values outside the constant range the performance of both styles is the same.

Unless the class must be compatible with JVMs predating Java 1.5, use either autoboxing or the valueOf() method when creating instances of Long, Integer, Short, Character, and Byte.

Dm: The equals and hashCode methods of URL are blocking (DMI_BLOCKING_METHODS_ON_URL)

The equals and hashCode method of URL perform domain name resolution, this can result in a big performance hit. See http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html for more information. Consider using java.net.URI instead.

Dm: Maps and sets of URLs can be performance hogs (DMI_COLLECTION_OF_URLS)

This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode method of URL perform domain name resolution, this can result in a big performance hit. See http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html for more information. Consider using java.net.URI instead.

Dm: La méthode invoque le constructeur inutile Boolean() ; utilisez Boolean.valueOf(...) à la place (DM_BOOLEAN_CTOR)

Créer de nouvelles instances de java.lang.Boolean gaspille la mémoire puisque les objets Boolean sont immuables et qu'il n'y a que deux valeurs utiles de ce type. Utilisez à la place la méthode Boolean.valueOf() pour créer des objets Boolean.

Dm: Ramasse-miettes explicite ; extrêmement douteux sauf dans du code de banc d'essai (DM_GC)

Le code appelle explicitement le ramasse-miettes. Mis à part l'emploi spécifique dans un banc d'essai, c'est très douteux.

Dans le passé, les cas où des personnes ont explicitement invoqué le ramasse-miettes dans des méthodes telles que close() ou finalize() ont creusés des gouffres dans les performances. Le ramasse-miettes peut-être très coûteux. Toute situation qui force des centaines ou des milliers de ramasse-miettes mettra à genoux une machine.

Dm: Méthode allouant un objet juste pour obtenir la classe (DM_NEW_FOR_GETCLASS)

Cette méthode alloue un objet juste pour appeler sa méthode getClass() afin d'obtenir l'objet Class correspondant. Il est plus simple d'accèder directement à la propriété .class de la classe.

Dm: Utiliser la méthode nextInt de Random plutôt que nextDouble pour générer un entier aléatoire (DM_NEXTINT_VIA_NEXTDOUBLE)

Si r est un java.util.Random, vous pouvez générer un nombre aléatoire entre 0 et n-1 en utilisant r.nextInt(n) plutôt que (int)(r.nextDouble() * n).

Dm: La méthode invoque le constructeur inutile String(String) ; utilisez juste l'argument (DM_STRING_CTOR)

Utiliser le constructeur java.lang.String(String) gaspille de la mémoire puisque l'objet ainsi construit serait fonctionnellement identique à la chaîne passée en paramètre. Utilisez juste la chaîne en argument directement.

Dm: La méthode appel toString() sur un objet String ; utilisez directement l'objet String (DM_STRING_TOSTRING)

Appeler String.toString() est juste une opération redondante. Utilisez directement l'objet String.

Dm: La méthode invoque le constructeur inutile String() ; utilisez juste "" (DM_STRING_VOID_CTOR)

Créer un nouveau objet java.lang.String en utilisant le constructeur sans argument gaspille de la mémoire parce que l'objet ainsi créé serait fonctionnellement identique à la constante de chaîne vide "". Java garantie que les chaînes constantes identiques seront représentées par le même objet String. C'est pourquoi vous devriez directement utiliser la constante de chaîne vide.

HSC: Huge string constants is duplicated across multiple class files (HSC_HUGE_SHARED_STRING_CONSTANT)

A large String constant is duplicated across multiple class files. This is likely because a final field is initialized to a String constant, and the Java language mandates that all references to a final field from other classes be inlined into that classfile. See JDK bug 6447475 for a description of an occurrence of this bug in the JDK and how resolving it reduced the size of the JDK by 1 megabyte.

SBSC: La méthode concatène des chaînes au moyen de + en boucle (SBSC_USE_STRINGBUFFER_CONCATENATION)

Cette méthode semble construire une String en utilisant une concaténation en boucle. A chaque itération, l'objet String est converti en StringBuffer/StringBuilder, complété, puis de nouveau converti en String. Ceci a un coût exponentiel en fonction du nombre d'itérations, puisque la chaîne est recopiée à chaque itération.

De meilleurs performances peuvent être obtenues en utilisant explicitement StringBuffer (ou StringBuilder en Java 5).

Par exemple :

// C'est mal !
String s = "";
for (int i = 0; i < field.length; ++i) {
  s = s + field[i];
}

// C'est mieux...
StringBuffer buf = new StringBuffer();
for (int i = 0; i < field.length; ++i) {
  buf.append(field[i]);
}
String s = buf.toString();

SIC: Devrait être une classe interne statique (SIC_INNER_SHOULD_BE_STATIC)

Cette classe est une classe interne, mais n'utilise pas sa référence vers l'objet qui l'a créée. Cette référence rend les instances de cette classe plus grosses et peut garder active la référence à l'objet créateur plus longtemps que nécessaire. Si possible, la classe devrait être transformée en classe interne static.

SIC: Peut-être transformée en classe interne statique nommée (SIC_INNER_SHOULD_BE_STATIC_ANON)

Cette classe est une classe interne qui n'utilise pas sa référence vers l'objet qui l'a créée. Cette référence rend l'objet plus gros et peut garder active la référence de l'objet créateur plus longtemps que nécessaire. Si possible, la classe devrait être transformée en classe interne static. Puisque les classes anonymes ne peuvent pas être marquées comme static, il faudrait également nommer cette classe.

SIC: Pourrait-être transformée en classe interne statique (SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS)

Cette classe est une classe interne mais elle n'utilise pas sa référence vers l'objet qui l'a créée, à part durant la création de l'objet interne. Cette référence rend les instances de cette classe plus grosses et peut forcer à garder active la référence de l'objet créateur plus longtemps que nécessaire. Si possible, la classe devrait-être transformée en classe interne static. Puisque la référence à l'objet créateur est requise durant la construction de la classe interne, le constructeur de celle-ci devrait-être modifié afin d'accepter en argument cette référence.

SS: Champ non lu : devrait-il être statique ? (SS_SHOULD_BE_STATIC)

Cette classe contient un champ d'instance final qui est initialisé par une valeur statique déterminée à la compilation. Envisagez de rendre ce champ static.

UM: Appel d'une méthode statique de la classe Math sur une valeur constante (UM_UNNECESSARY_MATH)

Cette méthode utilise une méthode statique de java.lang.Math sur une valeur constante. Dans ce cas, le résultat de cet appel peut être déterminé statiquement, ce qui est plus rapide et souvent plus précis. Les méthodes détectées sont :

UPM: Méthode privée jamais appelée (UPM_UNCALLED_PRIVATE_METHOD)

Cette méthode privée n'est jamais appelée. Bien qu'il soit possible que cette méthode soit appelée par réflexion, il y a plus de chances qu'elle ne soit jamais utilisée et qu'elle puisse être supprimée.

UrF: Champ inutilisé (URF_UNREAD_FIELD)

Ce champ n'est jamais lu. Envisagez de le supprimer de la classe.

UuF: Champ inutilisé (UUF_UNUSED_FIELD)

Ce champ n'est jamais utilisé. Envisagez de le supprimer de la classe.

WMI: Utilisation inefficace d'un itérateur sur keySet au lieu de entrySet (WMI_WRONG_MAP_ITERATOR)

Cette méthode accède à la valeur d'une entrée de Map au moyen d'une clé provenant d'un itérateur sur keySet. Il est plus efficace d'utiliser un itérateur sur l'entrySet de la Map, pour éviter la recherche par Map.get(clé).

Dm: Hardcoded constant database password (DMI_CONSTANT_DB_PASSWORD)

This code creates a database connect using a hardcoded, constant password. Anyone with access to either the source code or the compiled code can easily learn the password.

Dm: Empty database password (DMI_EMPTY_DB_PASSWORD)

This code creates a database connect using a blank or empty password. This indicates that the database is not protected by a password.

HRS: HTTP cookie formed from untrusted input (HRS_REQUEST_PARAMETER_TO_COOKIE)

This code constructs an HTTP Cookie using an untrusted HTTP parameter. If this cookie is added to an HTTP response, it will allow a HTTP response splitting vulnerability. See http://en.wikipedia.org/wiki/HTTP_response_splitting for more information.

FindBugs looks only for the most blatant, obvious cases of HTTP response splitting. If FindBugs found any, you almost certainly have more vulnerabilities that FindBugs doesn't report. If you are concerned about HTTP response splitting, you should seriously consider using a commercial static analysis or pen-testing tool.

HRS: HTTP Response splitting vulnerability (HRS_REQUEST_PARAMETER_TO_HTTP_HEADER)

This code directly writes an HTTP parameter to an HTTP header, which allows for a HTTP response splitting vulnerability. See http://en.wikipedia.org/wiki/HTTP_response_splitting for more information.

FindBugs looks only for the most blatant, obvious cases of HTTP response splitting. If FindBugs found any, you almost certainly have more vulnerabilities that FindBugs doesn't report. If you are concerned about HTTP response splitting, you should seriously consider using a commercial static analysis or pen-testing tool.

PT: Absolute path traversal in servlet (PT_ABSOLUTE_PATH_TRAVERSAL)

The software uses an HTTP request parameter to construct a pathname that should be within a restricted directory, but it does not properly neutralize absolute path sequences such as "/abs/path" that can resolve to a location that is outside of that directory. See http://cwe.mitre.org/data/definitions/36.html for more information.

FindBugs looks only for the most blatant, obvious cases of absolute path traversal. If FindBugs found any, you almost certainly have more vulnerabilities that FindBugs doesn't report. If you are concerned about absolute path traversal, you should seriously consider using a commercial static analysis or pen-testing tool.

PT: Relative path traversal in servlet (PT_RELATIVE_PATH_TRAVERSAL)

The software uses an HTTP request parameter to construct a pathname that should be within a restricted directory, but it does not properly neutralize sequences such as ".." that can resolve to a location that is outside of that directory. See http://cwe.mitre.org/data/definitions/23.html for more information.

FindBugs looks only for the most blatant, obvious cases of relative path traversal. If FindBugs found any, you almost certainly have more vulnerabilities that FindBugs doesn't report. If you are concerned about relative path traversal, you should seriously consider using a commercial static analysis or pen-testing tool.

SQL: Une chaîne non constante est passée à la méthode execute d'une commande SQL (SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE)

Cette méthode invoque la méthode execute d'une commande SQL (statement) avec une chaîne qui semble générée dynamiquement. Préférer la préparation de la commande avec un PreparedStatement, c'est plus efficace et bien moins vulnérable aux attaques par injection SQL (insertion de code SQL malveillant au sein d'une requête).

SQL: Une requète est préparée à partir d'une chaine non constante (SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING)

Ce code créé une requète SQL préparée à partir d'une chaine non constante. Les données qui permettent de construire cette chaine venant de l'utilisateur, elles pourraient, sans vérification, servir à faire de l'injection de SQL et ainsi modifier la requète afin qu'elle produise des résultats inattendus et indésirables.

XSS: JSP reflected cross site scripting vulnerability (XSS_REQUEST_PARAMETER_TO_JSP_WRITER)

This code directly writes an HTTP parameter to JSP output, which allows for a cross site scripting vulnerability. See http://en.wikipedia.org/wiki/Cross-site_scripting for more information.

FindBugs looks only for the most blatant, obvious cases of cross site scripting. If FindBugs found any, you almost certainly have more cross site scripting vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously consider using a commercial static analysis or pen-testing tool.

XSS: Servlet reflected cross site scripting vulnerability in error page (XSS_REQUEST_PARAMETER_TO_SEND_ERROR)

This code directly writes an HTTP parameter to a Server error page (using HttpServletResponse.sendError). Echoing this untrusted input allows for a reflected cross site scripting vulnerability. See http://en.wikipedia.org/wiki/Cross-site_scripting for more information.

FindBugs looks only for the most blatant, obvious cases of cross site scripting. If FindBugs found any, you almost certainly have more cross site scripting vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously consider using a commercial static analysis or pen-testing tool.

XSS: Servlet reflected cross site scripting vulnerability (XSS_REQUEST_PARAMETER_TO_SERVLET_WRITER)

This code directly writes an HTTP parameter to Servlet output, which allows for a reflected cross site scripting vulnerability. See http://en.wikipedia.org/wiki/Cross-site_scripting for more information.

FindBugs looks only for the most blatant, obvious cases of cross site scripting. If FindBugs found any, you almost certainly have more cross site scripting vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously consider using a commercial static analysis or pen-testing tool.

BC: Transtypage douteux d'un type Collection vers une classe abstraite (BC_BAD_CAST_TO_ABSTRACT_COLLECTION)

Ce code transtype un object de type Collection vers un type de collection abstrait (tel que Collection). Assurez vous que l'objet est bien du type précisé. Si vous désirez par exemple faire une itération sur une collection, le transtypage vers Set ou List est inutile.

BC: Transtypage douteux vers une collection concrète (BC_BAD_CAST_TO_CONCRETE_COLLECTION)

Ce code transtype une collection abstraite (telles que Collection, List, ou Set) vers une implémentation concrète spécifique (telles que ArrayList ou HashSet). Ceci n'est pas forcément correct, et peut rendre votre code plus fragile, puisqu'il un éventuel refactoring futur avec une autre implémentation concrète plus difficile. A défaut d'une raison valable, l'utilisation des classes abstraites est recommandée.

BC: Transtypage non vérifié/non confirmé (BC_UNCONFIRMED_CAST)

La faisablité du transtypage n'est pas vérifiée, et tous les objets candidats au transtypage ne sont pas légitimes. Assurez vous que la logique du programme est correcte et que le transtypage n'échouera pas.

BC: Unchecked/unconfirmed cast of return value from method (BC_UNCONFIRMED_CAST_OF_RETURN_VALUE)

This code performs an unchecked cast of the return value of a method. The code might be calling the method in such a way that the cast is guaranteed to be safe, but FindBugs is unable to verify that the cast is safe. Check that your program logic ensures that this cast will not fail.

BC: instanceof renverra toujours vrai (BC_VACUOUS_INSTANCEOF)

Ce test instanceof renverra toujours vrai. Même s'il est sûr, assurez-vous qu'il ne s'agit pas d'une erreur logique ou d'une mauvaise compréhension.

BSHIFT: Décalage à droite non signé et transtypage short/byte (ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT)

Le code effectue un décalage à droite non signé, dont le résultat est transtypé vers un short ou un byte, ce qui élimine les bits supérieurs du résultat. Puisque les bits supérieurs sont éliminés, il peut ne pas y avoir de différence entre un décalage à droite signé ou non signé (ceci dépend de la taille du décalage)

CI: Classe finale déclarant un champ protégé (CI_CONFUSED_INHERITANCE)

Cette classe est déclarée final mais comporte des champs protected. Cette classe étant finale, elle ne pourra jamais être dérivée et donc l'utilisation de protected est troublante. Le modificateur d'accès devrait être modifié à private ou public pour mettre en évidence la véritable utilisation du champ.

DB: Méthode utilsant le même code pour deux branches (DB_DUPLICATE_BRANCHES)

Cette méthode utilise le même code pour implémenter deux branches d'une condition. Vérifiez pour vous assurer que ce n'est pas une erreur de codage.

DB: Méthode utilisant le même code pour deux clauses switch (DB_DUPLICATE_SWITCH_CLAUSES)

Cette méthode utilise le même code pour implémenter deux cas différents d'un switch. Ce peut être normal mais il vaut mieux vérifier que ce n'est pas une erreur de codage.

DLS: Alimentation à perte d'une variable locale (DLS_DEAD_LOCAL_STORE)

Cette instruction assigne une valeur à une variable locale mais cette variable n'est pas lue par la suite. Ceci indique souvent une erreur puisque la valeur calculée n'est jamais utilisée.

Notez que le compilateur javac de Sun génère fréquemment ce genre d'affectations à perte. FindBugs analysant le byte-code généré, il n'y a pas de façon simple d'éliminer ces fausses alarmes.

DLS: Useless assignment in return statement (DLS_DEAD_LOCAL_STORE_IN_RETURN)

This statement assigns to a local variable in a return statement. This assignment has effect. Please verify that this statement does the right thing.

DLS: Alimentation à null d'une variable (DLS_DEAD_LOCAL_STORE_OF_NULL)

Le code alimente une variable locale avec null, la valeur n'étant jamais lue par la suite. Cette alimentation a pu être introduite pour faciliter le travail du ramasse-miettes, mais cela n'a plus aucun intérêt avec Java SE 6.

DLS: Dead store to local variable that shadows field (DLS_DEAD_LOCAL_STORE_SHADOWS_FIELD)

This instruction assigns a value to a local variable, but the value is not read or used in any subsequent instruction. Often, this indicates an error, because the value computed is never used. There is a field with the same name as the local variable. Did you mean to assign to that variable instead?

DMI: Chemin absolu codé en dur dans le code (DMI_HARDCODED_ABSOLUTE_FILENAME)

Ce code construit un objet File en utilisant un chemin absolu de fichier codé en dur (Ex. : new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");).

DMI: Objet non sérialisable écrit dans un ObjectOutput (DMI_NONSERIALIZABLE_OBJECT_WRITTEN)

Ce code semble transmettre un objet non sérialisable à la méthode ObjectOutput.writeObject. Une erreur se produira si cet objet est effectivement non sérialisable.

DMI: Appel de substring(0) qui retourne la valeur originale (DMI_USELESS_SUBSTRING)

Ce code appelle substring(0) sur une chaine, ce qui renvoit la valeur originale.

Dm: Thread passed where Runnable expected (DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED)

A Thread object is passed as a parameter to a method where a Runnable is expected. This is rather unusual, and may indicate a logic error or cause unexpected behavior.

Eq: Class doesn't override equals in superclass (EQ_DOESNT_OVERRIDE_EQUALS)

This class extends a class that defines an equals method and adds fields, but doesn't define an equals method itself. Thus, equality on instances of this class will ignore the identity of the subclass and the added fields. Be sure this is what is intended, and that you don't need to override the equals method. Even if you don't need to override the equals method, consider overriding it anyway to document the fact that the equals method for the subclass just return the result of invoking super.equals(o).

Eq: Unusual equals method (EQ_UNUSUAL)

This class doesn't do any of the patterns we recognize for checking that the type of the argument is compatible with the type of the this object. There might not be anything wrong with this code, but it is worth reviewing.

FE: Test d'égalité en virgule flottante. (FE_FLOATING_POINT_EQUALITY)

Cette opération teste l'égalité de deux valeurs en virgule flottante. Les calculs en virgule flottante pouvant introduire des arrondis, les valeurs flottantes ou doubles peuvent être imprécises. Pour les valeurs qui doivent être précises, telles que les valeurs monétaires, pensez à utiliser un type à précision fixe tel qu'un BigDecimal. Pour les valeurs qui n'ont pas besoin d'être précises, pensez à tester l'égalité sur une portée quelconque, par exemple : if ( Math.abs(x - y) < .0000001 ). Cf section 4.2.4 des spécifications du langage Java.

FS: Non-Boolean argument formatted using %b format specifier (VA_FORMAT_STRING_BAD_CONVERSION_TO_BOOLEAN)

An argument not of type Boolean is being formatted with a %b format specifier. This won't throw an exception; instead, it will print true for any non-null value, and false for null. This feature of format strings is strange, and may not be what you intended.

IA: Appel ambigu d'une méthode hérité ou externe (IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD)

Une classe interne invoque une méthode qui peut être résolue comme une méthode héritée ou comme une méthode définie dans une classe externe. La sémantique de Java fait qu'elle sera résolue en invoquant la méthode héritée, mais ce n'est peut être pas votre intention. Si vous souhaitez réellement invoquer la méthode héritée, faite le en utilisant super (Ex : appelé super.foo(17)) ce qui clarifiera votre code pour les autres lecteurs et pour FindBugs.

IC: Initialisation circulaire (IC_INIT_CIRCULARITY)

Une initialisation circulaire a été détectée dans les initialisations de variables statiques de deux classes référencées par l'instance en erreur. De nombreuses sortes de comportements inattendus peuvent surgir d'une telle situation.

ICAST: Résultat d'une division entière transtypé en nombre flottant (ICAST_IDIV_CAST_TO_DOUBLE)

Ce code transtype le résultat d'une division entière en un nombre flottant à double précision. Effectuer une division sur des nombres entiers n'est pas précis. Le fait que le résultat soit transtypé en double suggère que cette précision était voulue dès le départ. Peut être l'un ou l'autre des opérandes, ou les deux opérandes, auraient du être transtypé avant d'effectuer la division. Voici un exemple :

int x = 2;
int y = 5;
// Faux: renvoi 0.0
double value1 =  x / y;

// Juste: renvoi 0.4
double value2 =  x / (double) y;

ICAST: Résultat d'une multiplication entière transtypée en long (ICAST_INTEGER_MULTIPLY_CAST_TO_LONG)

Ce code effectue des multiplications entières et transtype le résultat en long, comme dans : long convertDaysToMilliseconds(int days) { return 1000*3600*24*days; }. Si la multiplication était réalisée en utilisant l'arithmétique long, vous pourriez éviter le risque de débordement de capacité du calcul. Vous pouvez par exemple corriger le code précédent par : long convertDaysToMilliseconds(int days) { return 1000L*3600*24*days; } ou

static final long MILLISECONDS_PER_DAY = 24L*3600*1000;
long convertDaysToMilliseconds(int days) { return days * MILLISECONDS_PER_DAY; } 

IM: Possibilité de débordement du calcul d'une moyenne (IM_AVERAGE_COMPUTATION_COULD_OVERFLOW)

Le code calcule la moyenne de deux entiers au moyen d'une division ou d'un décalage signé vers la droite, puis utilise le résultat comme indice d'un tableau. Si les valeurs moyennées sont très grandes, le calcul peut déborder (résultant en un très grand négatif). En supposant que le résultat doive toujours être positif, vous devriez plutôt utiliser un décalage à droite non signé. En d'autres termes, utilisez plutôt (low+high) >>> 1 au lieu de (low+high)/2.

Le bug existe dans de nombreuses implémentations des recherches binaires et des tris fusion. Martin Buchholz l'a recherché et corrigé dans les librairies du JDK et Joshua Bloch a largement publié ce modèle de bug.

IM: Test d'impaire ne fonctionnant pas avec les négatifs (IM_BAD_CHECK_FOR_ODD)

Le code utilise x % 2 == 1 pour véifier si une valeur est impaire, mais cela ne fonctionera pas avec une valeur négative (Ex. : (-5) % 2 == -1). Si ce code doit tester si une valeur est impaire, envisagez d'utiliser x & 1 == 1 ou x % 2 != 0.

INT: Reste entier modulo 1 (INT_BAD_REM_BY_1)

Cette expression (Ex. : exp % 1) est assurée de toujours renvoyer 0. Vouliez-vous plutot dire (exp & 1) ou (exp % 2) ?

INT: Vacuous bit mask operation on integer value (INT_VACUOUS_BIT_OPERATION)

This is an integer bit operation (and, or, or exclusive or) that doesn't do any useful work (e.g., v & 0xffffffff).

INT: Comparaison inutile de valeurs entières (INT_VACUOUS_COMPARISON)

Il y a une comparaison entière qui renvoie toujours la même valeur (Ex. : x <= Integer.MAX_VALUE).

MTIA: La classe hérite de Servlet et utilise les variables de l'instance. (MTIA_SUSPECT_SERVLET_INSTANCE_FIELD)

Cette classe hérite de la classe Servlet, et utilise une variable de l'instance. Puisqu'une seule instance d'une classe Servlet est créée par le cadre de travail J2EE, et est utilisée dans un environnement multitâche, ce paradigme est très fortement découragé et très certainement problématique. Considérer l'emploi seul de variables propres à la méthode.

MTIA: La classe hérite d'une classe action Struts et utilise les variables de l'instance. (MTIA_SUSPECT_STRUTS_INSTANCE_FIELD)

Cette classe hérite d'une classe Action Struts, et utilise une variable de cette instance. Puisqu'une seule instance de la classe Action Struts est créée par le cadre de travail Struts, et est utilisée dans un environnement multitâche, ce paradigme est très fortement découragé et très certainement problématique. Considérer l'emploi seul de variables propres à la méthode.

NP: Dereference of the result of readLine() without nullcheck (NP_DEREFERENCE_OF_READLINE_VALUE)

The result of invoking readLine() is dereferenced without checking to see if the result is null. If there are no more lines of text to read, readLine() will return null and dereferencing that will generate a null pointer exception.

NP: Déréférencement immédiat du résultat d'un readLine() (NP_IMMEDIATE_DEREFERENCE_OF_READLINE)

Le résultat d'un appel à readLine() est immédiatement déréférencé. S'il n'y a plus d'autre lignes de texte à lire, readLine() retournera null ce qui provoquera une NullPointerException lors du déréférencement.

NP: Chargement d'une valeur connue pour être à null (NP_LOAD_OF_KNOWN_NULL_VALUE)

La variable référencée est connue pour être à null suite à une vérification précédente. Bien que cela soit valide, ce peut être une erreur (peut-être vouliez-vous référencer une autre valeur ou le test précédent aurait-il due vérifier non-null plutôt que null).

NP: Method tightens nullness annotation on parameter (NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION)

A method should always implement the contract of a method it overrides. Thus, if a method takes a parameter that is marked as @Nullable, you shouldn't override that method in a subclass with a method where that parameter is @Nonnull. Doing so violates the contract that the method should handle a null parameter.

NP: Method relaxes nullness annotation on return value (NP_METHOD_RETURN_RELAXING_ANNOTATION)

A method should always implement the contract of a method it overrides. Thus, if a method takes is annotated as returning a @Nonnull value, you shouldn't override that method in a subclass with a method annotated as returning a @Nullable or @CheckForNull value. Doing so violates the contract that the method shouldn't return null.

NP: Pointeur à null renvoyé par une méthode qui risque d'être déréférencé (NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE)

La valeur renvoyée par une méthode est déréférencée alors que cette méthode peut renvoyer null. Ceci peut conduire à une NullPointerException quand le code sera exécuté.

NP: Possible null pointer dereference on branch that might be infeasible (NP_NULL_ON_SOME_PATH_MIGHT_BE_INFEASIBLE)

There is a branch of statement that, if executed, guarantees that a null value will be dereferenced, which would generate a NullPointerException when the code is executed. Of course, the problem might be that the branch or statement is infeasible and that the null pointer exception can't ever be executed; deciding that is beyond the ability of FindBugs. Due to the fact that this value had been previously tested for nullness, this is a definite possibility.

NP: Parameter must be non-null but is marked as nullable (NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE)

This parameter is always used in a way that requires it to be non-null, but the parameter is explicitly annotated as being Nullable. Either the use of the parameter or the annotation is wrong.

NP: Read of unwritten public or protected field (NP_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD)

The program is dereferencing a public or protected field that does not seem to ever have a non-null value written to it. Unless the field is initialized via some mechanism not seen by the analysis, dereferencing this value will generate a null pointer exception.

NS: Potentially dangerous use of non-short-circuit logic (NS_DANGEROUS_NON_SHORT_CIRCUIT)

This code seems to be using non-short-circuit logic (e.g., & or |) rather than short-circuit logic (&& or ||). In addition, it seem possible that, depending on the value of the left hand side, you might not want to evaluate the right hand side (because it would have side effects, could cause an exception or could be expensive.

Non-short-circuit logic causes both sides of the expression to be evaluated even when the result can be inferred from knowing the left-hand side. This can be less efficient and can result in errors if the left-hand side guards cases when evaluating the right-hand side can generate an error.

See the Java Language Specification for details

NS: Utilisation discutable de logique binaire (NS_NON_SHORT_CIRCUIT)

Ce code semble utiliser de la logique binaire (Ex. : & ou |) plutôt que les opérateurs booléens (&& ou ||). La logique binaire entraîne l'évaluation systématique de toute l'expression, même quand le résultat pourrait être immédiatement déduit. Ceci est moins performant et peut provoquer des erreurs lorsque la partie gauche de l'expression masque des cas de la partie droite.

PZLA: Envisagez de renvoyer un tableau vide plutôt que null (PZLA_PREFER_ZERO_LENGTH_ARRAYS)

Renvoyer un tableau vide constitue souvent une meilleure approche plutôt que de renvoyer une référence à null pour signaler qu'il n'y a pas de résultat (c'est-à-dire, une liste vide de résultats). De cette façon, aucune vérification explicite du null n'est nécessaire dans les méthodes clientes.

D'un autre côté, utiliser null signifie "il n'y a pas de réponse à cette question". Cela peut donc être approprié. Par exemple, File.listFiles() renvoi une liste vide si un répertoire donné ne contient pas de fichiers, et renvoi null si le fichier n'est pas un répertoire.

QF: Incrémentation compliquée, subtile au incorrecte dans une boucle for (QF_QUESTIONABLE_FOR_LOOP)

Etes vous certain que cette boucle incrémente la variable voulue ? Il sembleraît qu'une autre variable est initialisée et vérifiée par la boucle.

RCN: Comparaison redondante d'une valeur non nulle avec null (RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE)

Cette méthode contient une comparaison entre une référence connue pour être non nulle avec une autre référence connue pour être à null.

RCN: Comparaison redondante de deux valeurs nulles (RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES)

Cette méthode contient une comparaison redondante entre deux références connues pour être obligatoirement à null.

RCN: Test de nullité redondant sur une valeur non nulle (RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE)

Cette méthode contient un test redondant de nullité sur une valeur connue pour être non nulle.

RCN: Test de nullité redondant sur une valeur connue pour être à null (RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE)

Cette méthode contient un test redondant de nullité sur une valeur ne pouvant qu'être à null.

REC: java.lang.Exception est intercepté alors qu'Exception n'est jamais lancé (REC_CATCH_EXCEPTION)

Cette méthode utilise un block try-catch qui intercepte les objets Exception, mais Exception n'est jamais déclenché dans ce bloc, et RuntimeException n'est pas explicitement intercepté. C'est une erreur commune de dire que try / catch (Exception e) est identique à plusieurs try / catch, mais cette tournure intercepte également les RuntimeException, masquant des bugs potentiels.

RI: Classe implémentant la même interface que sa super-classe (RI_REDUNDANT_INTERFACES)

Cette classe déclare implémenter une interface qui est aussi implémentée par une de ses classes mères. Ceci est redondant : dès qu'une super-classe implémente une interface, toutes les sous-classes le font aussi par défaut. Cela peut indiquer que la hiérarchie d'héritage a changé depuis la création de cette classe et la cible de l'implémentation de l'interface doit peut-être être reprise en considération.

RV: Méthode vérifiant que le résultat d'un String.indexOf() est positif (RV_CHECK_FOR_POSITIVE_INDEXOF)

La méthode appelle String.indexOf() et vérifie si le résultat est strictement positif ou pas. Il est plus habituel de vérifier si le résultat est négatif. Il n'est strictement positif que lorsque la sous-chaine recherchée apparaît ailleurs qu'au début de la chaine.

RV: Méthode ignorant le résultat d'un readLine() après avoir vérifié qu'il est non nul (RV_DONT_JUST_NULL_CHECK_READLINE)

La valeur renvoyée par readLine() est ignorée après avoir vérifié s'il n'est pas à null. Dans quasiment tous les cas, si le résultat n'est pas à null, vous souhaiterez utiliser cette valeur. Appeler de nouveau readLine() vous renverra une ligne différente.

RV: Reste d'un hashCode pouvant être négatif (RV_REM_OF_HASHCODE)

Ce code calcule le code de hachage, puis son reste modulo une certaine valeur. Puisque le code de hachage peut être négatif, le reste peut également l'être.

En supposant que vous vouliez garantir que le résultat de votre opération ne soit pas négatif, vous devriez modifier votre code. Si le diviseur est une puissance de 2, vous pourriez utiliser un décalage binaire à la place (c'est-à-dire x.hashCode()&(n-1) au lieu de x.hashCode()%n). Cela est probablement plus rapide que de calculer le reste. Si le diviseur n'est pas une puissance de 2, vous devriez prendre la valeur absolue du reste (Math.abs(x.hashCode()%n)).

RV: Reste d'un entier signé 32 bits aléeatoire (RV_REM_OF_RANDOM_INT)

Ce code génère un entier signé aléatoire puis calcule le reste de cette valeur modulo une autre valeur. Puisque ce nombre aléatoire peut être négatif, le reste de l'opération peut également l'être. Soyez sûr que c'est voulu, et envisagez d'utiliser à la place la méthode Random.nextInt(int).

RV: Method ignores return value, is this OK? (RV_RETURN_VALUE_IGNORED_INFERRED)

This code calls a method and ignores the return value. The return value is the same type as the type the method is invoked on, and from our analysis it looks like the return value might be important (e.g., like ignoring the return value of String.toLowerCase()).

We are guessing that ignoring the return value might be a bad idea just from a simple analysis of the body of the method. You can use a @CheckReturnValue annotation to instruct FindBugs as to whether ignoring the return value of this method is important or acceptable.

Please investigate this closely to decide whether it is OK to ignore the return value.

RV: Return value of method without side effect is ignored (RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT)

This code calls a method and ignores the return value. However our analysis shows that the method (including its implementations in subclasses if any) does not produce any effect other than return value. Thus this call can be removed.

We are trying to reduce the false positives as much as possible, but in some cases this warning might be wrong. Common false-positive cases include:

- The method is designed to be overridden and produce a side effect in other projects which are out of the scope of the analysis.

- The method is called to trigger the class loading which may have a side effect.

- The method is called just to get some exception.

If you feel that our assumption is incorrect, you can use a @CheckReturnValue annotation to instruct FindBugs that ignoring the return value of this method is acceptable.

SA: Double assignment of field (SA_FIELD_DOUBLE_ASSIGNMENT)

This method contains a double assignment of a field; e.g.

  int x,y;
  public void foo() {
    x = x = 17;
  }

Assigning to a field twice is useless, and may indicate a logic error or typo.

SA: Double assignment of local variable (SA_LOCAL_DOUBLE_ASSIGNMENT)

This method contains a double assignment of a local variable; e.g.

  public void foo() {
    int x,y;
    x = x = 17;
  }

Assigning the same value to a variable twice is useless, and may indicate a logic error or typo.

SA: Auto-alimentation d'une variable locale (SA_LOCAL_SELF_ASSIGNMENT)

Cette méthode contient une auto-alimentation d'une variable locale, par exemple :

public vida foo() {
  int x = 3;
  x = x;
}

De telles affectations sont inutiles et peuvent indiquer une faute de frappe ou une erreur de logique.

SF: Un switch comporte un cas qui déborde sur le suivant (SF_SWITCH_FALLTHROUGH)

Cette méthode contient un switch dont l'un des cas déborde sur le suivant. Normalement, vous devez terminer chaque cas avec une instruction break ou return.

SF: Switch statement found where default case is missing (SF_SWITCH_NO_DEFAULT)

This method contains a switch statement where default case is missing. Usually you need to provide a default case.

Because the analysis only looks at the generated bytecode, this warning can be incorrect triggered if the default case is at the end of the switch statement and the switch statement doesn't contain break statements for other cases.

ST: Ecriture d'un champ statique depuis la méthode d'une instance (ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)

La méthode de l'instance écrit la valeur d'un champ statique. Cela peut être difficile à gérer si plusieurs instances ont la possibilité d'écrire cette valeur et cela ressemble surtout à une mauvaise pratique.

Se: Private readResolve method not inherited by subclasses (SE_PRIVATE_READ_RESOLVE_NOT_INHERITED)

This class defines a private readResolve method. Since it is private, it won't be inherited by subclasses. This might be intentional and OK, but should be reviewed to ensure it is what is intended.

Se: Transient field of class that isn't Serializable. (SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS)

The field is marked as transient, but the class isn't Serializable, so marking it as transient has absolutely no effect. This may be leftover marking from a previous version of the code in which the class was transient, or it may indicate a misunderstanding of how serialization works.

TQ: Value required to have type qualifier, but marked as unknown (TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_ALWAYS_SINK)

A value is used in a way that requires it to be always be a value denoted by a type qualifier, but there is an explicit annotation stating that it is not known where the value is required to have that type qualifier. Either the usage or the annotation is incorrect.

TQ: Value required to not have type qualifier, but marked as unknown (TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_NEVER_SINK)

A value is used in a way that requires it to be never be a value denoted by a type qualifier, but there is an explicit annotation stating that it is not known where the value is prohibited from having that type qualifier. Either the usage or the annotation is incorrect.

UC: Condition has no effect (UC_USELESS_CONDITION)

This condition always produces the same result as the value of the involved variable was narrowed before. Probably something else was meant or condition can be removed.

UC: Condition has no effect due to the variable type (UC_USELESS_CONDITION_TYPE)

This condition always produces the same result due to the type range of the involved variable. Probably something else was meant or condition can be removed.

UC: Useless object created (UC_USELESS_OBJECT)

Our analysis shows that this object is useless. It's created and modified, but its value never go outside of the method or produce any side-effect. Either there is a mistake and object was intended to be used or it can be removed.

This analysis rarely produces false-positives. Common false-positive cases include:

- This object used to implicitly throw some obscure exception.

- This object used as a stub to generalize the code.

- This object used to hold strong references to weak/soft-referenced objects.

UC: Useless object created on stack (UC_USELESS_OBJECT_STACK)

This object is created just to perform some modifications which don't have any side-effect. Probably something else was meant or the object can be removed.

UC: Useless non-empty void method (UC_USELESS_VOID_METHOD)

Our analysis shows that this non-empty void method does not actually perform any useful work. Please check it: probably there's a mistake in its code or its body can be fully removed.

We are trying to reduce the false positives as much as possible, but in some cases this warning might be wrong. Common false-positive cases include:

- The method is intended to trigger loading of some class which may have a side effect.

- The method is intended to implicitly throw some obscure exception.

UCF: Instruction de contrôle du flux inutile (UCF_USELESS_CONTROL_FLOW)

Cette méthode contient une instruction de contrôle du flux inutile. Ceci est souvent provoqué par inadvertance, en utilisant un paragraphe vide comme corps d'une condition. Exemple :

if (argv.length == 1);
    System.out.println("Hello, " + argv[0]);

UCF: Useless control flow to next line (UCF_USELESS_CONTROL_FLOW_NEXT_LINE)

This method contains a useless control flow statement in which control flow follows to the same or following line regardless of whether or not the branch is taken. Often, this is caused by inadvertently using an empty statement as the body of an if statement, e.g.:

    if (argv.length == 1);
        System.out.println("Hello, " + argv[0]);

UrF: Unread public/protected field (URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD)

This field is never read.  The field is public or protected, so perhaps it is intended to be used with classes not seen as part of the analysis. If not, consider removing it from the class.

UuF: Unused public or protected field (UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD)

This field is never used.  The field is public or protected, so perhaps it is intended to be used with classes not seen as part of the analysis. If not, consider removing it from the class.

UwF: Champ non initialisé dans le constructeur (UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR)

Ce champ n'est jamais initialisé dans aucun constructeur, et est de ce fait null une fois l'objet initialisé. Soit il s'agit d'une erreur, soit il s'agit d'un design douteux puisque ce champ génèra une exception s'il est déréférencé avant toute initialisation.

UwF: Unwritten public or protected field (UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD)

No writes were seen to this public/protected field.  All reads of it will return the default value. Check for errors (should it have been initialized?), or remove it if it is useless.

XFB: Méthode instanciant directement une implémentation spécifique des interfaces XML (XFB_XML_FACTORY_BYPASS)

Cette méthode instancie une implémentation spécifique de l'interface XML. Il est préférable d'utiliser les classes 'Factory' fournies pour créer ces objets, ce qui permet de changer d'implémentation à l'exécution. Pour des détails, cf. :

• javax.xml.parsers.DocumentBuilderFactory
• javax.xml.parsers.SAXParserFactory
• javax.xml.transform.TransformerFactory
• org.w3c.dom.Document.createXXXX

Send comments to findbugs@cs.umd.edu