fix: several bug-prone behaviors identified by higher spotbugs ranks (#871)

* test: increase spotbugs rank

let's see how high we can increase the rank without too much pain and
suffering...

* fix: 5

* fix: 6

* fix: thread-safe date formatter

* fix: repeated conditional

* fix: disable bug-prone `ClasUtilsFile.getFileList(String,String,String)`, since unused

* fix: Non-virtual method call in constructor passes null for...

...non-null parameter of another constructor
(`NP_NULL_PARAM_DEREF_NONVIRTUAL`)

* fix: `setMass` `mass` parameter is dead upon entry but overwritten...

spotbugs rank-7 bug `IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN`

* fix: undeclared dependency

* fix: fix or suppress some rank-8 bugs

* fix: synchronized singleton getters

* fix: suppress searlizable singletons

* fix: remove public ctors from `SwapManager` singleton

* fix: suppress static method hiding of `DetectorRepsonse.readHipoEvent`

better than breaking the API...

* fix: go back to rank 7

* fix: remove commented out code

* fix: actuallly back to rank 7

Author: c-dilks

build-coatjava.sh

@@ -280,11 +280,8 @@ fi
 
 # run spotbugs
 if $runSpotBugs; then
-  # mvn com.github.spotbugs:spotbugs-maven-plugin:spotbugs # spotbugs goal produces a report target/spotbugsXml.xml for each module
-  $mvn com.github.spotbugs:spotbugs-maven-plugin:check # check goal produces a report and produces build failed if bugs
-  # the spotbugsXml.xml file is easiest read in a web browser
-  # see http://spotbugs.readthedocs.io/en/latest/maven.html and https://spotbugs.github.io/spotbugs-maven-plugin/index.html for more info
-  if [ $? != 0 ] ; then echo "spotbugs failure" >&2 ; exit 1 ; fi
+  libexec/spotbugs.sh ${mvnArgs[@]:-} || (echo "ERROR: spotbugs failure" >&2 && exit 1)
+  echo "spotbugs spotted no bugs!"
 fi
 
 

common-tools/clas-detector/src/main/java/org/jlab/detector/swaps/SwapManager.java

@@ -55,8 +55,6 @@ public final class SwapManager {
     private ConstantsManager currConman = null;
     private SchemaFactory schema = null;
 
-    private static SwapManager instance = null;
-
     public Set<String> getDetectors() {
         return this.detsToBanks.keySet();
     }
@@ -67,32 +65,7 @@ public List<String> getBanks(String detectorName) {
         return this.detsToBanks.get(detectorName);
     }
 
-    private SwapManager() {}
-    
-    public static SwapManager getInstance() {
-        if (instance == null) {
-            instance = new SwapManager();
-        }
-        return instance;
-    }
-
-    /**
-     * @param detectorNames
-     * @param prevTimestamp in CCDB format:  MM/DD/YYYY
-     * @param currTimestamp in CCDB format:  MM/DD/YYYY
-     */
-    public SwapManager(List<String> detectorNames, String prevTimestamp,String currTimestamp) {
-        this.initialize(detectorNames, prevTimestamp, currTimestamp);    
-    }
-
-    /**
-     * @param detectorNames
-     * @param previous timestamp/variation used for translation tables during decoding
-     * @param current timestamp/variation with correct translation tables
-     */
-    public SwapManager(List<String> detectorNames,ConstantsManager previous,ConstantsManager current) {
-        this.initialize(detectorNames, previous, current);
-    }
+    public SwapManager() {}
 
     /**
      * @param detectorNames
@@ -265,14 +238,14 @@ private void initDetectors(List<String> detectorNames) {
     }
 
     public static void main(String[] args) {
-        
-        SwapManager man1 = new SwapManager(Arrays.asList("DC"),"08/10/2020","10/13/2024");
-        System.err.println(man1.banksToTables.get("DC::tot"));
 
-        SwapManager noman = getInstance();
-        System.out.println(Arrays.toString(noman.get(11014, "/daq/tt/bmt",3,5,320,0)));
-        
-        SwapManager man = new SwapManager(Arrays.asList("BMT"),"08/10/2020","10/13/2020");
+        SwapManager man = new SwapManager();
+        System.out.println(Arrays.toString(man.get(11014, "/daq/tt/bmt",3,5,320,0)));
+
+        man.initialize(Arrays.asList("DC"),"08/10/2020","10/13/2024");
+        System.err.println(man.banksToTables.get("DC::tot"));
+
+        man.initialize(Arrays.asList("BMT"),"08/10/2020","10/13/2020");
         man.get(11014,man.getTable("BMT"),"sector",3,6,8,0);
         System.out.println("SwapManager:\n"+man);
         System.out.println(man.get(11014,man.getTable("BMT"),"sector",99,22,33,44));

common-tools/clas-geometry/src/main/java/org/jlab/detector/geant4/DCGeant4Factory.java

@@ -1,17 +1,7 @@
-/*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
- */
 package org.jlab.detector.geant4;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.HashMap;
 import org.jlab.geom.geant.Geant4Basic;
-import org.jlab.geom.prim.Line3D;
-import org.jlab.geom.prim.Plane3D;
-import org.jlab.geom.prim.Point3D;
 import org.jlab.geom.base.ConstantProvider;
 import org.jlab.geom.prim.Vector3D;
 
@@ -45,15 +35,11 @@ final class DCdatabase {
     private int nguardwires;
 
     private final String dcdbpath = "/geometry/dc/";
-    private static DCdatabase instance = null;
+    private static DCdatabase instance = new DCdatabase();
 
-    private DCdatabase() {
-    }
+    private DCdatabase() {}
 
     public static DCdatabase getInstance() {
-        if (instance == null) {
-            instance = new DCdatabase();
-        }
         return instance;
     }
 
@@ -278,7 +264,7 @@ public class DCGeant4Factory {
 
     DCdatabase dbref = DCdatabase.getInstance();
     private Geant4Basic motherVolume = new Geant4Basic("root", "Box", 0);
-    private HashMap<String, String> properties = new HashMap<String, String>();
+    private HashMap<String, String> properties = new HashMap<>();
 
     private int nsgwires;
 

common-tools/clas-utils/src/main/java/org/jlab/utils/benchmark/Benchmark.java

@@ -16,8 +16,8 @@ public class Benchmark {
     private static final Benchmark benchmarkInstance = new Benchmark();
     private final Map<String,BenchmarkTimer> timerStore = new LinkedHashMap<>();
     private Timer updateTimer = null;
-
-    public Benchmark(){}
+    
+    private Benchmark() {}
 
     public static Benchmark getInstance(){
         return benchmarkInstance;

common-tools/clas-utils/src/main/java/org/jlab/utils/system/ClasUtilsFile.java

@@ -132,25 +132,7 @@ public static List<String>  getFileList(String env, String rpath){
         }
         return ClasUtilsFile.getFileList(directory);
     }
-    /**
-     * returns a file list that contains files with given extension
-     * @param env
-     * @param rpath
-     * @param ext
-     * @return 
-     */
-    public static List<String>  getFileList(String env, String rpath, String ext){
-        String directory = ClasUtilsFile.getResourceDir(env, rpath);
-        if(directory!=null) return new ArrayList<>();
-        
-        List<String> files = ClasUtilsFile.getFileList(directory);
-        List<String> selected = new ArrayList<>();
-        for(String item : files){
-            if(item.endsWith(ext)==true) selected.add(item);
-        }
-        return selected;
-    }
-    
+
     public static void   writeFile(String filename, List<String> lines){
         System.out.println("writing file --->  " + filename);
         BufferedWriter writer = null;

common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/MagneticFields.java

@@ -7,10 +7,11 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.PrintStream;
-import java.text.SimpleDateFormat;
+import java.time.format.DateTimeFormatter;
+import java.time.ZoneId;
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.StringTokenizer;
-import java.util.TimeZone;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -40,14 +41,9 @@ public class MagneticFields {
 	/**
 	 * A formatter to get the time in down to seconds (no day info).
 	 */
-	private static SimpleDateFormat formatterlong;
-
-	static {
-		TimeZone tz = TimeZone.getDefault();
-
-		formatterlong = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
-		formatterlong.setTimeZone(tz);
-	}
+        private static final DateTimeFormatter formatterlong = DateTimeFormatter
+          .ofPattern("yyyy/MM/dd HH:mm:ss")
+          .withZone(ZoneId.systemDefault());
 
 	// version of mag field package
 	private static String VERSION = "1.20";
@@ -1660,7 +1656,7 @@ public String fileBaseNames() {
 	 * @return a string representation of the current time, down to seconds.
 	 */
 	public static String dateStringLong(long longtime) {
-		return formatterlong.format(longtime);
+		return formatterlong.format(Instant.ofEpochMilli(longtime));
 	}
 
 	/**

common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/converter/Converter.java

@@ -196,7 +196,7 @@ public void done() {
 				zIndex++;
 			}
 
-			if ((gdata[PHI].max > 31) && (gdata[PHI].max > 31)) {
+			if (gdata[PHI].max > 31) {
 				System.err.println("Correcting PhiMax to 360 from " + gdata[PHI].max);
 			}
 
@@ -850,4 +850,4 @@ public static void memoryToGEMCTorusConverter() {
 
 	}
 
-}
+}

common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/ColorScaleModel.java

@@ -41,7 +41,7 @@ public class ColorScaleModel {
 	 * @param minVal the minimum value;
 	 * @param maxVal the maximum value the array of colors.
 	 */
-	public ColorScaleModel(double minVal, double maxVal, Color[] colors) {
+	private ColorScaleModel(double minVal, double maxVal, Color[] colors) {
 		_colors = colors;
 		_minVal = minVal;
 		_maxVal = maxVal;
@@ -52,7 +52,7 @@ public ColorScaleModel(double minVal, double maxVal, Color[] colors) {
 	 * 
 	 * @return a standard blue to red color scale
 	 */
-	public static ColorScaleModel blueToRed() {
+	public static synchronized ColorScaleModel blueToRed() {
 		if (_blueToRed == null) {
 			Color colors[] = {
 					// new Color(0, 0, 139),
@@ -245,4 +245,4 @@ private Color getInterpretedColor(Color c1, Color c2, double fract) {
 		return new Color(r3, g3, b3, a3);
 	}
 
-}
+}

common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/Environment.java

@@ -95,7 +95,7 @@ public Font getCommonFont(int size) {
 	 * 
 	 * @return the singleton object.
 	 */
-	public static Environment getInstance() {
+	public static synchronized Environment getInstance() {
 		if (instance == null) {
 			instance = new Environment();
 		}
@@ -287,4 +287,4 @@ public static void memoryReport(String message) {
 	public static void main(String arg[]) {
 		System.out.println(Environment.getInstance());
 	}
-}
+}

common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/ImageManager.java

@@ -42,7 +42,7 @@ private ImageManager() {
 	 * 
 	 * @return the image manager singleton.
 	 */
-	public static ImageManager getInstance() {
+	public static synchronized ImageManager getInstance() {
 		if (imageManager == null) {
 			try {
 				imageManager = new ImageManager();