Merge branch 'spotbugs' into findbugs

 Conflicts:
	.classpath
	pom.xml

Author: mebigfatguy

README.md

@@ -49,6 +49,7 @@ Contributors
 * Pavel Roskin
 * Kevin Seymour
 * Piotrek Żygieło
+* Guillaume Toison
 
 
 fb-contrib has two main branches, 'findbugs' and 'spotbugs'. Code is committed to spotbugs, and then merged back to findbugs.

build.xml

@@ -31,8 +31,8 @@
 	<property name="javac.debug" value="on" />
 	<property name="test_reports.dir" value="${target.dir}/reports/test"/>
 
-	<property name="fb-contrib.version" value="7.6.6" />
-	<property name="sb-contrib.version" value="7.6.6" />
+	<property name="fb-contrib.version" value="7.6.7-SNAPSHOT" />
+	<property name="sb-contrib.version" value="7.6.7-SNAPSHOT" />
 
 	<property name="sonatype.dir" value="${user.home}/.fb-contrib-${fb-contrib.version}-sonatype" />
 

etc/findbugs.xml

@@ -23,15 +23,15 @@
 
 	<!-- Detectors -->
 
-    <!-- COMMENT OUT FOR RELEASE
+    <!-- COMMENT OUT FOR RELEASE -->
 
     <Detector class="com.mebigfatguy.fbcontrib.debug.OCSDebugger" speed="fast"/>
 
     <Detector class="com.mebigfatguy.fbcontrib.detect.BloatedSynchronizedBlock" speed="fast" reports="BSB_BLOATED_SYNCHRONIZED_BLOCK" hidden="true" /> 
 
     <Detector class="com.mebigfatguy.fbcontrib.detect.BloatedAssignmentScope" speed="fast" reports="BAS_BLOATED_ASSIGNMENT_SCOPE" hidden="true" />
 
-         COMMENT OUT FOR RELEASE -->
+    <!-- COMMENT OUT FOR RELEASE -->
 
 	<Detector class="com.mebigfatguy.fbcontrib.collect.CollectStatistics" speed="fast" reports="" hidden="true" />
 
@@ -644,7 +644,7 @@
 	<BugPattern abbrev="LUI" type="LUI_USE_COLLECTION_ADD" category="CORRECTNESS" />
 	<BugPattern abbrev="LUI" type="LUI_USE_GET0" category="CORRECTNESS" />
 	<BugPattern abbrev="FII" type="FII_USE_METHOD_REFERENCE" category="CORRECTNESS" />
-	<BugPattern abbrev="FII" type="FII_AVOID_CONTAINS_ON_COLLECTED_STREAM"/>
+	<BugPattern abbrev="FII" type="FII_AVOID_CONTAINS_ON_COLLECTED_STREAM" category="CORRECTNESS" />
 	<BugPattern abbrev="FII" type="FII_USE_ANY_MATCH" category="CORRECTNESS"/>
 	<BugPattern abbrev="FII" type="FII_USE_FIND_FIRST" category="CORRECTNESS"/>
 	<BugPattern abbrev="FII" type="FII_COMBINE_FILTERS" category="CORRECTNESS"/>

etc/messages.xml

@@ -2708,7 +2708,7 @@ static {
 
 	<BugPattern type="PMB_LOCAL_BASED_JAXB_CONTEXT">
 	   <ShortDescription>Local JAXBContext created on demand</ShortDescription>
-	   <LongDescription>Method {1} createa a local JAXBContext on demand</LongDescription>
+	   <LongDescription>Method {1} creates a local JAXBContext on demand</LongDescription>
 	   <Details>
 	       <![CDATA[
 	       <p>This method creates a JAXBContext and stores it in a local variable. This
@@ -6208,6 +6208,7 @@ if (shouldCalcHalting && (calculateHaltingProbability() &gt; 0) { }
     		<p>Unfortunately there isn't just one @Nullable annotation, but this detector will recognize:</p>
     		<ul>
     		<li>org.jetbrains.annotations.Nullable</li>
+	        <li>jakarta.annotation.Nullable</li>
 	        <li>javax.annotation.Nullable</li>
 	        <li>javax.annotation.CheckForNull</li>
 	        <li>edu.umd.cs.findbugs.annotations.Nullable</li>

pom.xml

@@ -7,7 +7,8 @@
 
     <groupId>com.mebigfatguy.fb-contrib</groupId>
     <artifactId>fb-contrib</artifactId>
-    <version>7.6.6</version>
+    <version>7.6.7-SNAPSHOT</version>
+
 
     <!-- TODO: Oss parent is obsolete, define items directly for releasing -->
     <parent>

src/main/java/com/mebigfatguy/fbcontrib/detect/OptionalIssues.java

@@ -21,6 +21,8 @@
 import java.util.ArrayDeque;
 import java.util.BitSet;
 import java.util.Deque;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Set;
 
 import javax.annotation.Nullable;
@@ -35,6 +37,8 @@
 import org.apache.bcel.classfile.JavaClass;
 import org.apache.bcel.classfile.Method;
 
+import com.mebigfatguy.fbcontrib.collect.MethodInfo;
+import com.mebigfatguy.fbcontrib.collect.Statistics;
 import com.mebigfatguy.fbcontrib.utils.BugType;
 import com.mebigfatguy.fbcontrib.utils.FQMethod;
 import com.mebigfatguy.fbcontrib.utils.SignatureBuilder;
@@ -46,7 +50,9 @@
 import edu.umd.cs.findbugs.BytecodeScanningDetector;
 import edu.umd.cs.findbugs.OpcodeStack;
 import edu.umd.cs.findbugs.OpcodeStack.CustomUserValue;
+import edu.umd.cs.findbugs.SourceLineAnnotation;
 import edu.umd.cs.findbugs.ba.ClassContext;
+import edu.umd.cs.findbugs.ba.SignatureParser;
 import edu.umd.cs.findbugs.ba.XMethod;
 
 /**
@@ -55,6 +61,12 @@
 @CustomUserValue
 public class OptionalIssues extends BytecodeScanningDetector {
 
+	private enum OptionalType {
+		PLAIN,
+		BOXED
+	}
+	
+	private static final String OPTIONAL_SIGNATURE = "Ljava/util/Optional;";
     private static Set<String> BOXED_OPTIONAL_TYPES = UnmodifiableSet.create("Ljava/lang/Integer;", "Ljava/lang/Long;",
             "Ljava/lang/Double;");
 
@@ -99,6 +111,8 @@ OPTIONAL_OR_ELSE_METHOD, new FQMethod("java/util/OptionalDouble", "orElse", "(D)
     private OpcodeStack stack;
     private JavaClass currentClass;
     private Deque<ActiveStackOp> activeStackOps;
+    private Map<OpcodeStack.Item, SourceLineAnnotation> boxedItems = new HashMap<>();
+    private boolean methodIsConstrained;
 
     static {
 		INVOKE_OPS.set(Const.INVOKEINTERFACE);
@@ -155,7 +169,21 @@ public void visitClassContext(ClassContext classContext) {
     public void visitCode(Code obj) {
         stack.resetForMethodEntry(this);
         activeStackOps.clear();
+        boxedItems.clear();
+        methodIsConstrained = false;
+        
+        String returnType = new SignatureParser(getMethodSig()).getReturnTypeSignature();
+        if (OPTIONAL_SIGNATURE.equals(returnType)) {
+        	MethodInfo mi = Statistics.getStatistics().getMethodStatistics(getClassName(), getMethodName(), getMethodSig());
+        	methodIsConstrained = mi != null && mi.isDerived();
+        }
         super.visitCode(obj);
+        
+        for (SourceLineAnnotation slAnno : boxedItems.values()) {
+          bugReporter.reportBug(
+          new BugInstance(this, BugType.OI_OPTIONAL_ISSUES_PRIMITIVE_VARIANT_PREFERRED.name(),
+                  LOW_PRIORITY).addClass(this).addMethod(this).addSourceLine(slAnno));
+        }
     }
 
     /**
@@ -168,7 +196,7 @@ public void visitCode(Code obj) {
     @Override
     public void sawOpcode(int seen) {
         FQMethod curCalledMethod = null;
-        Boolean sawPlainOptional = null;
+        OptionalType optionalType = null;
 
         try {
             switch (seen) {
@@ -207,9 +235,7 @@ public void sawOpcode(int seen) {
                         OpcodeStack.Item itm = stack.getStackItem(0);
                         String itmSig = itm.getSignature();
                         if (BOXED_OPTIONAL_TYPES.contains(itmSig)) {
-                            bugReporter.reportBug(
-                                    new BugInstance(this, BugType.OI_OPTIONAL_ISSUES_PRIMITIVE_VARIANT_PREFERRED.name(),
-                                            LOW_PRIORITY).addClass(this).addMethod(this).addSourceLine(this));
+                        	optionalType = OptionalType.BOXED;
                         }
                     }
                 }
@@ -245,7 +271,7 @@ public void sawOpcode(int seen) {
                         }
                     }
                     if (OPTIONAL_OR_ELSE_METHOD.equals(curCalledMethod)) {
-                        sawPlainOptional = Boolean.TRUE;
+;                    	optionalType = OptionalType.PLAIN;
                     }
                 } else if (OR_ELSE_GET_METHODS.contains(curCalledMethod)) {
                     if (!activeStackOps.isEmpty()) {
@@ -276,12 +302,18 @@ public void sawOpcode(int seen) {
                         }
                     }
                     if (OPTIONAL_OR_ELSE_GET_METHOD.equals(curCalledMethod)) {
-                        sawPlainOptional = Boolean.TRUE;
+                    	optionalType = OptionalType.PLAIN;
                     }
                 } else if (OPTIONAL_GET_METHOD.equals(curCalledMethod)) {
-                    sawPlainOptional = Boolean.TRUE;
+                	optionalType = OptionalType.PLAIN;
                 }
                 break;
+                
+			case Const.ARETURN:
+				if (methodIsConstrained && stack.getStackDepth() > 0) {
+					boxedItems.remove(stack.getStackItem(0));
+				}
+				break;
             }
         } catch (ClassNotFoundException e) {
             bugReporter.reportMissingClass(e);
@@ -295,9 +327,13 @@ public void sawOpcode(int seen) {
                 while (activeStackOps.size() > stackDepth) {
                     activeStackOps.removeFirst();
                 }
-                if (sawPlainOptional != null) {
+                if (optionalType != null) {
                     OpcodeStack.Item itm = stack.getStackItem(0);
-                    itm.setUserValue(sawPlainOptional);
+                    itm.setUserValue(optionalType);
+                    if (optionalType == OptionalType.BOXED) {
+	                    boxedItems.put(itm, SourceLineAnnotation.fromVisitedInstruction(OptionalIssues.this.getClassContext(),
+                    		OptionalIssues.this, getPC()));
+                    }
                 }
             }
         }

src/samples/java/ex/OI_Sample.java

@@ -6,7 +6,7 @@
 import java.util.OptionalInt;
 import java.util.function.Supplier;
 
-public class OI_Sample {
+public class OI_Sample implements OptInf386 {
 
     public String useDelayedExecution(Optional<String> o, String a, String b) {
 
@@ -73,4 +73,12 @@ public String fpGet384(String parameterName, Supplier<String> defaultValueSuppli
     public boolean equalsToEmpty(Optional<String> foo) {
     	return foo.equals(Optional.empty());
     }
+    
+    public 	Optional<Object> fpGetOpt386() {
+    	return Optional.of(Double.valueOf(10));
+    }
+}
+
+interface OptInf386 {
+	Optional<Object> fpGetOpt386();
 }