FindBugs Bug DescriptionsThis document lists the standard bug patterns reported by FindBugs version 3.0.1. DescriptionsBC: Equals method should not assume anything about the type of its argument (BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS)The BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK)This method compares an expression such as . 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: Class implements Cloneable but does not define or use clone method (CN_IDIOM)Class implements Cloneable but does not define or use the clone method. CN: clone method does not call super.clone() (CN_IDIOM_NO_SUPER_CALL)This non-final class defines a clone() method that does not call super.clone(). If this class ("A") is extended by a subclass ("B"), and the subclass B calls super.clone(), then it is likely that B's clone() method will return an object of type A, which violates the standard contract for clone(). If all clone() methods call super.clone(), then they are guaranteed to use Object.clone(), which always returns an object of the correct type. 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: Abstract class defines covariant compareTo() method (CO_ABSTRACT_SELF)This class defines a covariant version of 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: Covariant compareTo() method defined (CO_SELF_NO_OBJECT)This class defines a covariant version of DE: Method might drop exception (DE_MIGHT_DROP)This method might drop an exception. In general, exceptions should be handled or reported in some way, or they should be thrown out of the method. DE: Method might ignore exception (DE_MIGHT_IGNORE)This method might ignore an exception. In general, exceptions should be handled or reported in some way, or they should be thrown out of the method. 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 Dm: Method invokes System.exit(...) (DM_EXIT)Invoking System.exit shuts down the entire Java virtual machine. This should only been done when it is appropriate. Such calls make it hard or impossible for your code to be invoked by other code. Consider throwing a RuntimeException instead. Dm: Method invokes dangerous method runFinalizersOnExit (DM_RUN_FINALIZERS_ON_EXIT)Never call System.runFinalizersOnExit or Runtime.runFinalizersOnExit for any reason: they are among the most dangerous methods in the Java libraries. -- Joshua Bloch ES: Comparison of String parameter using == or != (ES_COMPARING_PARAMETER_STRING_WITH_EQ)This code compares a ES: Comparison of String objects using == or != (ES_COMPARING_STRINGS_WITH_EQ)This code compares Eq: Abstract class defines covariant equals() method (EQ_ABSTRACT_SELF)This class defines a covariant version of 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: 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 From the JavaDoc for the compareTo method in the Comparable interface:
It is strongly recommended, but not strictly required that
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 Eq: Covariant equals() method defined (EQ_SELF_NO_OBJECT)This class defines a covariant version of FI: Empty finalizer should be deleted (FI_EMPTY)Empty FI: Explicit invocation of finalizer (FI_EXPLICIT_INVOCATION)This method contains an explicit invocation of the If a connected set of objects beings finalizable, then the VM will invoke the finalize method on all the finalizable object, possibly at the same time in different threads. Thus, it is a particularly bad idea, in the finalize method for a class X, invoke finalize on objects referenced by X, because they may already be getting finalized in a separate thread. 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: Finalizer does not call superclass finalizer (FI_MISSING_SUPER_CALL)This FI: Finalizer nullifies superclass finalizer (FI_NULLIFY_SUPER)This empty FI: Finalizer does nothing but call superclass finalizer (FI_USELESS)The only thing this 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: Class defines equals() but not hashCode() (HE_EQUALS_NO_HASHCODE)This class overrides HE: Class defines equals() and uses Object.hashCode() (HE_EQUALS_USE_HASHCODE)This class overrides If you don't think instances of this class will ever be inserted into a HashMap/HashTable, the recommended HE: Class defines hashCode() but not equals() (HE_HASHCODE_NO_EQUALS)This class defines a HE: Class defines hashCode() and uses Object.equals() (HE_HASHCODE_USE_OBJECT_EQUALS)This class defines a If you don't think instances of this class will ever be inserted into a HashMap/HashTable, the recommended HE: Class inherits equals() and uses Object.hashCode() (HE_INHERITS_EQUALS_USE_HASHCODE)This class inherits If you don't want to define a hashCode method, and/or don't believe the object will ever be put into a HashMap/Hashtable, define the IC: Superclass uses subclass during initialization (IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION)During the initialization of a class, the class makes an active use of a subclass. That subclass will not yet be initialized at the time of this use. For example, in the following code, IMSE: Dubious catching of IllegalMonitorStateException (IMSE_DONT_CATCH_IMSE)IllegalMonitorStateException is generally only thrown in case of a design flaw in your code (calling wait or notify on an object you do not hold a lock on). ISC: Needless instantiation of class that only supplies static methods (ISC_INSTANTIATE_STATIC_CLASS)This class allocates an object that is based on a class that only supplies static methods. This object does not need to be created, just access the static methods directly using the class name as a qualifier. It: Iterator next() method can't throw NoSuchElementException (IT_NO_SUCH_ELEMENT)This class implements the J2EE: Store of non serializable object into HttpSession (J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION)This code seems to be storing a non-serializable object into an HttpSession. If this session is passivated or migrated, an error will result. JCIP: Fields of immutable classes should be final (JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS)The class is annotated with net.jcip.annotations.Immutable or javax.annotation.concurrent.Immutable, and the rules for those annotations require that all fields are final. . 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: equals() method does not check for null argument (NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT)This implementation of equals(Object) violates the contract defined by java.lang.Object.equals() because it does not check for null being passed as the argument. All equals() methods should return false if passed a null value. 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: Class names should start with an upper case letter (NM_CLASS_NAMING_CONVENTION)Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML). Nm: Class is not derived from an Exception, even though it is named as such (NM_CLASS_NOT_EXCEPTION)This class is not derived from another exception, but ends with 'Exception'. This will be confusing to users of this class. Nm: Confusing method names (NM_CONFUSING)The referenced methods have names that differ only by capitalization. Nm: Field names should start with a lower case letter (NM_FIELD_NAMING_CONVENTION)Names of fields that are not final should be in mixed case with a lowercase first letter and the first letters of subsequent words capitalized. 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: Method names should start with a lower case letter (NM_METHOD_NAMING_CONVENTION)Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized. 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., 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., 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:
The 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: Method may fail to close database resource (ODR_OPEN_DATABASE_RESOURCE)The method creates a database resource (such as a database connection or row set), does not assign it to any fields, pass it to other methods, or return it, and does not appear to close the object on all paths out of the method. Failure to close database resources on all paths out of a method may result in poor performance, and could cause the application to have problems communicating with the database. ODR: Method may fail to close database resource on exception (ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH)The method creates a database resource (such as a database connection or row set), does not assign it to any fields, pass it to other methods, or return it, and does not appear to close the object on all exception paths out of the method. Failure to close database resources on all paths out of a method may result in poor performance, and could cause the application to have problems communicating with the database. OS: Method may fail to close stream (OS_OPEN_STREAM)The method creates an IO stream object, does not assign it to any fields, pass it to other methods that might close it, or return it, and does not appear to close the stream on all paths out of the method. This may result in a file descriptor leak. It is generally a good idea to use a OS: Method may fail to close stream on exception (OS_OPEN_STREAM_EXCEPTION_PATH)The method creates an IO stream object, does not assign it to any fields, pass it to other methods, or return it, and does not appear to close it on all possible exception paths out of the method. This may result in a file descriptor leak. It is generally a good idea to use a 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 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 RR: Method ignores results of InputStream.read() (RR_NOT_CHECKED)This method ignores the return value of one of the variants of RR: Method ignores results of InputStream.skip() (SR_NOT_CHECKED)This method ignores the return value of 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 SI: Static initializer creates instance before all static final fields assigned (SI_INSTANCE_BEFORE_FINALS_ASSIGNED)The class's static initializer creates an instance of the class before all of the static final fields are assigned. SW: Certain swing methods needs to be invoked in Swing thread (SW_SWING_METHODS_INVOKED_IN_SWING_THREAD)(From JDC Tech Tip): The Swing methods show(), setVisible(), and pack() will create the associated peer for the frame. With the creation of the peer, the system creates the event dispatch thread. This makes things problematic because the event dispatch thread could be notifying listeners while pack and validate are still processing. This situation could result in two threads going through the Swing component-based GUI -- it's a serious flaw that could result in deadlocks or other related threading issues. A pack call causes components to be realized. As they are being realized (that is, not necessarily visible), they could trigger listener notification on the event dispatch thread. Se: Non-transient non-serializable instance field in serializable class (SE_BAD_FIELD)This Serializable class defines a non-primitive instance field which is neither transient, Serializable, or 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: Non-serializable value stored into instance field of a serializable class (SE_BAD_FIELD_STORE)A non-serializable value is stored into a non-transient field of a serializable class. Se: Comparator doesn't implement Serializable (SE_COMPARATOR_SHOULD_BE_SERIALIZABLE)This class implements the 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 isn't final (SE_NONFINAL_SERIALVERSIONID)This class defines a Se: serialVersionUID isn't long (SE_NONLONG_SERIALVERSIONID)This class defines a Se: serialVersionUID isn't static (SE_NONSTATIC_SERIALVERSIONID)This class defines a Se: Class is Serializable but its superclass doesn't define a void constructor (SE_NO_SUITABLE_CONSTRUCTOR)This class implements the Se: Class is Externalizable but doesn't define a void constructor (SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION)This class implements the Se: The readResolve method must be declared with a return type of Object. (SE_READ_RESOLVE_MUST_RETURN_OBJECT)In order for the readResolve method to be recognized by the serialization mechanism, it must be declared to have a return type of Object. Se: Transient field that isn't set by deserialization. (SE_TRANSIENT_FIELD_NOT_RESTORED)This class contains a field that is updated at multiple places in the class, thus it seems to be part of the state of the class. However, since the field is marked as transient and not set in readObject or readResolve, it will contain the default value in any deserialized instance of the class. SnVI: Class is Serializable, but doesn't define serialVersionUID (SE_NO_SERIALVERSIONID)This class implements the UI: Usage of GetResource may be unsafe if class is extended (UI_INHERITANCE_UNSAFE_GETRESOURCE)Calling BC: Impossible cast (BC_IMPOSSIBLE_CAST)This cast will always throw a ClassCastException. FindBugs tracks type information from instanceof checks, and also uses more precise information about the types of values returned from methods and loaded from fields. Thus, it may have more precise information that just the declared type of a variable, and can use this to determine that a cast will always throw an exception at runtime. 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 This will usually fail by throwing a ClassCastException. The The correct way to do get an array of a specific type from a collection is to use There is one common/known exception exception to this. The BC: instanceof will always return false (BC_IMPOSSIBLE_INSTANCEOF)This instanceof test will always return false. Although this is safe, make sure it isn't an indication of some misunderstanding or some other logic error. 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 In particular, the following code for packing a byte array into an int is badly wrong: The following idiom will work instead: BIT: Incompatible bit masks (BIT_AND)This method compares an expression of the form (e & C) to D, which will always compare unequal due to the specific values of constants C and D. This may indicate a logic error or typo. BIT: Check to see if ((...) & 0) == 0 (BIT_AND_ZZ)This method compares an expression of the form (e & 0) to 0, which will always compare equal. This may indicate a logic error or typo. BIT: Incompatible bit masks (BIT_IOR)This method compares an expression of the form (e | C) to D. which will always compare unequal due to the specific values of constants C and D. This may indicate a logic error or typo. Typically, this bug occurs because the code wants to perform a membership test in a bit set, but uses the bitwise OR operator ("|") instead of bitwise AND ("&"). BIT: Bitwise OR of signed byte value (BIT_IOR_OF_SIGNED_BYTE)Loads a byte value (e.g., a value loaded from a byte array or returned by a method with return type byte) and performs a bitwise OR with that value. Byte values are sign extended to 32 bits before any any bitwise operations are performed on the value. Thus, if In particular, the following code for packing a byte array into an int is badly wrong: The following idiom will work instead: BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK_HIGH_BIT)This method compares an expression such as . 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: Class overrides a method implemented in super class Adapter wrongly (BOA_BADLY_OVERRIDDEN_ADAPTER)This method overrides a method found in a parent class, where that class is an Adapter that implements a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not get called when the event occurs. 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: 32 bit int shifted by an amount not in the range -31..31 (ICAST_BAD_SHIFT_AMOUNT)The code performs shift of a 32 bit int by a constant amount outside the range -31..31. The effect of this is to use the lower 5 bits of the integer value to decide how much to shift by (e.g., shifting by 40 bits is the same as shifting by 8 bits, and shifting by 32 bits is the same as shifting by zero bits). This probably isn't what was expected, and it is at least confusing. DLS: Useless increment in return statement (DLS_DEAD_LOCAL_INCREMENT_IN_RETURN)This statement has a return such as 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 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: Overwritten increment (DLS_OVERWRITTEN_INCREMENT)The code performs an increment operation (e.g., 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 DMI: Bad constant value for month (DMI_BAD_MONTH)This code passes a constant month value outside the expected range of 0..11 to a method. 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: hasNext method invokes next (DMI_CALLING_NEXT_FROM_HASNEXT)The hasNext() method invokes the next() method. This is almost certainly wrong, since the hasNext() method is not supposed to change the state of the iterator, and the next method is supposed to change the state of the iterator. 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 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 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 Dm: Can't use reflection to check for presence of annotation without runtime retention (DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION)Unless an annotation has itself been annotated with @Retention(RetentionPolicy.RUNTIME), the annotation can't be observed using reflection (e.g., by using the isAnnotationPresent method). . 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: equals() used to compare array and nonarray (EC_ARRAY_AND_NONARRAY)This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem to be an array. If things being compared are of different types, they are guaranteed to be unequal and the comparison is almost certainly an error. Even if they are both arrays, the equals method on arrays only determines of the two arrays are the same object. To compare the contents of the arrays, use java.util.Arrays.equals(Object[], Object[]). EC: Invocation of equals() on an array, which is equivalent to == (EC_BAD_ARRAY_COMPARE)This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals method of Object, calling equals on an array is the same as comparing their addresses. To compare the contents of the arrays, use 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: Call to equals(null) (EC_NULL_ARG)This method calls equals(Object), passing a null value as the argument. According to the contract of the equals() method, this call should always return EC: Call to equals() comparing unrelated class and interface (EC_UNRELATED_CLASS_AND_INTERFACE)This method calls equals(Object) on two references, one of which is a class and the other an interface, where neither the class nor any of its non-abstract subclasses implement the interface. Therefore, the objects being compared are unlikely to be members of the same class at runtime (unless some application classes were not analyzed, or dynamic class loading can occur at runtime). According to the contract of equals(), objects of different classes should always compare as unequal; therefore, according to the contract defined by java.lang.Object.equals(Object), the result of this comparison will always be false at runtime. EC: Call to equals() comparing different interface types (EC_UNRELATED_INTERFACES)This method calls equals(Object) on two references of unrelated interface types, where neither is a subtype of the other, and there are no known non-abstract classes which implement both interfaces. Therefore, the objects being compared are unlikely to be members of the same class at runtime (unless some application classes were not analyzed, or dynamic class loading can occur at runtime). According to the contract of equals(), objects of different classes should always compare as unequal; therefore, according to the contract defined by java.lang.Object.equals(Object), the result of this comparison will always be false at runtime. EC: Call to equals() comparing different types (EC_UNRELATED_TYPES)This method calls equals(Object) on two references of different class types and analysis suggests they will be to objects of different classes at runtime. Further, examination of the equals methods that would be invoked suggest that either this call will always return false, or else the equals method is not be symmetric (which is a property required by the contract for equals in class Object). 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 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 Eq: equals() method defined that doesn't override Object.equals(Object) (EQ_OTHER_USE_OBJECT)This class defines an 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 Eq: Covariant equals() method defined, Object.equals(Object) inherited (EQ_SELF_USE_OBJECT)This class defines a covariant version of the FE: Doomed test for equality to NaN (FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER)This code checks to see if a floating point value is equal to the special Not A Number value (e.g., 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, 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, 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,
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 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 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: 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: ICAST: Integral value cast to double and then passed to Math.ceil (ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL)This code converts an integral value (e.g., int or long) to a double precision floating point number and then passing the result to the Math.ceil() function, which rounds a double to the next higher integer value. This operation should always be a no-op, since the converting an integer to a double should give a number with no fractional part. It is likely that the operation that generated the value to be passed to Math.ceil was intended to be performed using double precision floating point arithmetic. ICAST: int value cast to float and then passed to Math.round (ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND)This code converts an int value to a float precision floating point number and then passing the result to the Math.round() function, which returns the int/long closest to the argument. This operation should always be a no-op, since the converting an integer to a float should give a number with no fractional part. It is likely that the operation that generated the value to be passed to Math.round was intended to be performed using floating point arithmetic. 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 or IJU: TestCase has no tests (IJU_NO_TESTS)Class is a JUnit TestCase but has not implemented any test methods IJU: TestCase defines setUp that doesn't call super.setUp() (IJU_SETUP_NO_SUPER)Class is a JUnit TestCase and implements the setUp method. The setUp method should call super.setUp(), but doesn't. IJU: TestCase implements a non-static suite method (IJU_SUITE_NOT_STATIC)Class is a JUnit TestCase and implements the suite() method. The suite method should be declared as being static, but isn't. IJU: TestCase defines tearDown that doesn't call super.tearDown() (IJU_TEARDOWN_NO_SUPER)Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call super.tearDown(), but doesn't. IL: A collection is added to itself (IL_CONTAINER_ADDED_TO_ITSELF)A collection is added to itself. As a result, computing the hashCode of this set will throw a StackOverflowException. IL: An apparent infinite loop (IL_INFINITE_LOOP)This loop doesn't seem to have a way to terminate (other than by perhaps throwing an exception). IL: An apparent infinite recursive loop (IL_INFINITE_RECURSIVE_LOOP)This method unconditionally invokes itself. This would seem to indicate an infinite recursive loop that will result in a stack overflow. IM: Integer multiply of result of integer remainder (IM_MULTIPLYING_RESULT_OF_IREM)The code multiplies the result of an integer remaining by an integer constant. Be sure you don't have your operator precedence confused. For example i % 60 * 1000 is (i % 60) * 1000, not 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 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: A parameter is dead upon entry to a method but overwritten (IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN)The initial value of this parameter is ignored, and the parameter is overwritten here. This often indicates a mistaken belief that the write to the parameter will be conveyed back to the caller. MF: Class defines field that masks a superclass field (MF_CLASS_MASKS_FIELD)This class defines a field with the same name as a visible instance field in a superclass. This is confusing, and may indicate an error if methods update or access one of the fields when they wanted the other. MF: Method defines a variable that obscures a field (MF_METHOD_MASKS_FIELD)This method defines a local variable with the same name as a field in this class or a superclass. This may cause the method to read an uninitialized value from the field, leave the field uninitialized, or both. NP: Null pointer dereference (NP_ALWAYS_NULL)A null pointer is dereferenced here. This will lead to a NP: Null pointer dereference in method on exception path (NP_ALWAYS_NULL_EXCEPTION)A pointer which is null on an exception path is dereferenced here. This will lead to a Also note that FindBugs considers the default case of a switch statement to be an exception path, since the default case is often infeasible. NP: Method does not check for null argument (NP_ARGUMENT_MIGHT_BE_NULL)A parameter to this method has been identified as a value that should always be checked to see whether or not it is null, but it is being dereferenced without a preceding null check. 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 value is guaranteed to be dereferenced (NP_GUARANTEED_DEREF)There is a statement or branch 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). Note that a check such as 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: Method call passes null to a non-null parameter (NP_NONNULL_PARAM_VIOLATION)This method passes a null value as the parameter of a method which must be non-null. Either this parameter has been explicitly marked as @Nonnull, or analysis has determined that this parameter is always dereferenced. NP: Method may return null, but is declared @Nonnull (NP_NONNULL_RETURN_VIOLATION)This method may return a null value, but the method (or a superclass method which it overrides) is declared to return @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 null pointer dereference (NP_NULL_ON_SOME_PATH)There is a branch of statement that, if executed, guarantees that a null value will be dereferenced, which would generate a NP: Possible null pointer dereference in method on exception path (NP_NULL_ON_SOME_PATH_EXCEPTION)A reference value which is null on some exception control path is dereferenced here. This may lead to a Also note that FindBugs considers the default case of a switch statement to be an exception path, since the default case is often infeasible. NP: Method call passes null for non-null parameter (NP_NULL_PARAM_DEREF)This method call passes a null value for a non-null method parameter. Either the parameter is annotated as a parameter that should always be non-null, or analysis has shown that it will always be dereferenced. NP: Method call passes null for non-null parameter (NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS)A possibly-null value is passed at a call site where all known target methods require the parameter to be non-null. Either the parameter is annotated as a parameter that should always be non-null, or analysis has shown that it will always be dereferenced. NP: Non-virtual method call passes null for non-null parameter (NP_NULL_PARAM_DEREF_NONVIRTUAL)A possibly-null value is passed to a non-null method parameter. Either the parameter is annotated as a parameter that should always be non-null, or analysis has shown that it will always be dereferenced. 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: Store of null value into field annotated @Nonnull (NP_STORE_INTO_NONNULL_FIELD)A value that could be null is stored into a field that has been annotated as @Nonnull. NP: Read of unwritten field (NP_UNWRITTEN_FIELD)The program is dereferencing a 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. Nm: Class defines equal(Object); should it be equals(Object)? (NM_BAD_EQUAL)This class defines a method Nm: Class defines hashcode(); should it be hashCode()? (NM_LCASE_HASHCODE)This class defines a method called Nm: Class defines tostring(); should it be toString()? (NM_LCASE_TOSTRING)This class defines a method called Nm: Apparent method/constructor confusion (NM_METHOD_CONSTRUCTOR_CONFUSION)This regular method has the same name as the class it is defined in. It is likely that this was intended to be a constructor. If it was intended to be a constructor, remove the declaration of a void return value. If you had accidentally defined this method, realized the mistake, defined a proper constructor but can't get rid of this method due to backwards compatibility, deprecate the method. Nm: Very confusing method names (NM_VERY_CONFUSING)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. 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:
The QBA: Method assigns boolean literal in boolean expression (QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT)This method assigns a literal boolean value (true or false) to a boolean variable inside an if or while expression. Most probably this was supposed to be a boolean comparison using ==, not an assignment using =. 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: Suspicious reference comparison (RC_REF_COMPARISON)This method compares two reference values 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. RCN: Nullcheck of value previously dereferenced (RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE)A value is checked here to see whether it is null, but this value can't be null because it was previously dereferenced and if it were null a null pointer exception would have occurred at the earlier dereference. Essentially, this code and the previous dereference disagree as to whether this value is allowed to be null. Either the check is redundant or the previous dereference is erroneous. RE: Invalid syntax for regular expression (RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION)The code here uses a regular expression that is invalid according to the syntax for regular expressions. This statement will throw a PatternSyntaxException when executed. RE: File.separator used for regular expression (RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION)The code here uses RE: "." or "|" used for regular expression (RE_POSSIBLE_UNINTENDED_PATTERN)A String function is being invoked and "." or "|" is being passed to a parameter that takes a regular expression as an argument. Is this what you intended? For example
|