refactor to validBaudNumber_s_

JMRI · Jun 20, 2019 · baa8731 · baa8731
1 parent 27784c5
commit baa8731
Show file tree

Hide file tree

Showing 78 changed files with 98 additions and 96 deletions.
diff --git a/java/src/jmri/jmrix/AbstractSerialPortController.java b/java/src/jmri/jmrix/AbstractSerialPortController.java
@@ -150,7 +150,7 @@ public void configureBaudNumber(String indexString) {
         int baudNum;
         int index = 0;
         String[] rates = validBaudRates();
-        int[] numbers = validBaudNumber(); // TODO refactor method name to validBaudNumbers() - multiple values
+        int[] numbers = validBaudNumbers();
         if (numbers == null) { // simulators return null
             mBaudRate = null;
             log.warn("no serial port speed values received, OK for simulator");
@@ -210,8 +210,8 @@ public void configureBaudNumber(String indexString) {
     @Override
     public void configureBaudIndex(int index) {
         int baud = 0; // represents "(none)"
-        if (validBaudNumber() != null) {
-            for (int i = 0; i < validBaudNumber().length; i++) {
+        if (validBaudNumbers() != null) {
+            for (int i = 0; i < validBaudNumbers().length; i++) {
                 if (validBaudRates()[i].equals(mBaudRate)) {
                     mBaudRate = validBaudRates()[i];
                     break;
@@ -238,7 +238,7 @@ public String getCurrentBaudRate() {
     @Override
     public String getCurrentBaudNumber() {
         if (mBaudRate != null) {
-            int[] numbers = validBaudNumber(); // TODO refactor to validBaudNumbers() - multiple
+            int[] numbers = validBaudNumbers();
             String[] rates = validBaudRates();
             String baudNumString = "";
             // find the configured baud rate value
@@ -273,7 +273,9 @@ public int getCurrentBaudIndex() {
      * This method need not be reimplemented unless the subclass is using
      * currentBaudNumber, which requires it.
      */
-    public int[] validBaudNumber() {
+    @edu.umd.cs.findbugs.annotations.SuppressFBWarnings(value = "PZLA_PREFER_ZERO_LENGTH_ARRAYS",
+    justification = "null signal incorrect implementation of portcontroller")
+    public int[] validBaudNumbers() {
         log.error("default validBaudNumber implementation should not be used", new Exception());
         return null;
     }
@@ -288,7 +290,7 @@ public int[] validBaudNumber() {
      */
     public int currentBaudNumber(String currentBaudRate) {
         String[] rates = validBaudRates();
-        int[] numbers = validBaudNumber();
+        int[] numbers = validBaudNumbers();
 
         // return if arrays invalid
         if (numbers == null) {

diff --git a/java/src/jmri/jmrix/SerialPortAdapter.java b/java/src/jmri/jmrix/SerialPortAdapter.java
@@ -56,7 +56,7 @@ public interface SerialPortAdapter extends PortAdapter {
     /**
      * Get an array of valid baud rates; used to display valid options.
      */
-    public int[] validBaudNumber();
+    public int[] validBaudNumbers();
 
     /**
      * Set the baud rate. Only to be used after construction, but before the

diff --git a/java/src/jmri/jmrix/acela/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/acela/serialdriver/SerialDriverAdapter.java
@@ -152,8 +152,8 @@ public String[] validBaudRates() {
      * Return array of valid baud rates as integers.
      */
     @Override
-    public int[] validBaudNumber() {
-    // Really just want 9600 Baud for Acela
+    public int[] validBaudNumbers() {
+    // Only 9600 Baud for Acela
         return new int[]{9600};
     }
 

diff --git a/java/src/jmri/jmrix/bachrus/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/bachrus/serialdriver/SerialDriverAdapter.java
@@ -177,7 +177,7 @@ public String[] validBaudRates() {
      * Return array of valid baud rates as integers.
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{9600};
     }
 

diff --git a/java/src/jmri/jmrix/can/adapters/gridconnect/GcSerialDriverAdapter.java b/java/src/jmri/jmrix/can/adapters/gridconnect/GcSerialDriverAdapter.java
@@ -339,7 +339,7 @@ public int[] validBaudValues() {
      * TODO refactor validBaudValues() to validBaudNumber(s)
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return validBaudValues();
     }
 

diff --git a/.../src/jmri/jmrix/can/adapters/gridconnect/can2usbino/serialdriver/SerialDriverAdapter.java b/.../src/jmri/jmrix/can/adapters/gridconnect/can2usbino/serialdriver/SerialDriverAdapter.java
@@ -50,7 +50,7 @@ public int[] validBaudValues() {
      * TODO refactor validBaudValues() to validBaudNumber(s)
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return validBaudValues();
     }
 

diff --git a/java/src/jmri/jmrix/can/adapters/gridconnect/canusb/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/can/adapters/gridconnect/canusb/serialdriver/SerialDriverAdapter.java
@@ -34,7 +34,7 @@ public int[] validBaudValues() {
      * TODO refactor validBaudValues() to validBaudNumber(s)
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return validBaudValues();
     }
 

diff --git a/java/src/jmri/jmrix/can/adapters/gridconnect/lccbuffer/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/can/adapters/gridconnect/lccbuffer/serialdriver/SerialDriverAdapter.java
@@ -34,7 +34,7 @@ public int[] validBaudValues() {
      * TODO refactor validBaudValues() to validBaudNumber(s)
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return validBaudValues();
     }
 

diff --git a/java/src/jmri/jmrix/can/adapters/lawicell/SerialDriverAdapter.java b/java/src/jmri/jmrix/can/adapters/lawicell/SerialDriverAdapter.java
@@ -170,7 +170,7 @@ public int[] validBaudValues() {
      * TODO refactor validBaudValues() to validBaudNumber(s)
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return validBaudValues();
     }
 

diff --git a/java/src/jmri/jmrix/can/adapters/lawicell/canusb/serialdriver/CanUsbDriverAdapter.java b/java/src/jmri/jmrix/can/adapters/lawicell/canusb/serialdriver/CanUsbDriverAdapter.java
@@ -35,7 +35,7 @@ public int[] validBaudValues() {
      * TODO refactor validBaudValues() to validBaudNumber(s)
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return validBaudValues();
     }
 

diff --git a/java/src/jmri/jmrix/can/adapters/loopback/Port.java b/java/src/jmri/jmrix/can/adapters/loopback/Port.java
@@ -60,7 +60,7 @@ public String[] validBaudRates() {
     } // is hidden from user in connection config UI
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{};
     }
 

diff --git a/java/src/jmri/jmrix/cmri/serial/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/cmri/serial/serialdriver/SerialDriverAdapter.java
@@ -178,7 +178,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/dcc4pc/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/dcc4pc/serialdriver/SerialDriverAdapter.java
@@ -175,7 +175,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{115200};
     }
 

diff --git a/java/src/jmri/jmrix/dccpp/serial/DCCppAdapter.java b/java/src/jmri/jmrix/dccpp/serial/DCCppAdapter.java
@@ -194,7 +194,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/dccpp/simulator/DCCppSimulatorAdapter.java b/java/src/jmri/jmrix/dccpp/simulator/DCCppSimulatorAdapter.java
@@ -177,7 +177,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/direct/serial/SerialDriverAdapter.java b/java/src/jmri/jmrix/direct/serial/SerialDriverAdapter.java
@@ -178,7 +178,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{19200};
     }
 

diff --git a/java/src/jmri/jmrix/direct/simulator/SimulatorAdapter.java b/java/src/jmri/jmrix/direct/simulator/SimulatorAdapter.java
@@ -180,7 +180,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/easydcc/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/easydcc/serialdriver/SerialDriverAdapter.java
@@ -158,7 +158,7 @@ public String[] validBaudRates() {
      * Return array of valid baud rates as integers.
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{9600};
     }
 

diff --git a/java/src/jmri/jmrix/easydcc/simulator/SimulatorAdapter.java b/java/src/jmri/jmrix/easydcc/simulator/SimulatorAdapter.java
@@ -172,7 +172,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/grapevine/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/grapevine/serialdriver/SerialDriverAdapter.java
@@ -193,7 +193,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/grapevine/simulator/SimulatorAdapter.java b/java/src/jmri/jmrix/grapevine/simulator/SimulatorAdapter.java
@@ -196,7 +196,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/ieee802154/serialdriver/SerialDriverAdapter.java b/java/src/jmri/jmrix/ieee802154/serialdriver/SerialDriverAdapter.java
@@ -171,7 +171,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/ieee802154/xbee/XBeeAdapter.java b/java/src/jmri/jmrix/ieee802154/xbee/XBeeAdapter.java
@@ -207,7 +207,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/internal/InternalAdapter.java b/java/src/jmri/jmrix/internal/InternalAdapter.java
@@ -54,7 +54,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/lenz/XNetSimulatorPortController.java b/java/src/jmri/jmrix/lenz/XNetSimulatorPortController.java
@@ -97,7 +97,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/lenz/hornbyelite/EliteAdapter.java b/java/src/jmri/jmrix/lenz/hornbyelite/EliteAdapter.java
@@ -184,7 +184,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/lenz/li100/LI100Adapter.java b/java/src/jmri/jmrix/lenz/li100/LI100Adapter.java
@@ -191,7 +191,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/lenz/li100f/LI100fAdapter.java b/java/src/jmri/jmrix/lenz/li100f/LI100fAdapter.java
@@ -180,7 +180,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/lenz/li101/LI101Adapter.java b/java/src/jmri/jmrix/lenz/li101/LI101Adapter.java
@@ -179,7 +179,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/lenz/liusb/LIUSBAdapter.java b/java/src/jmri/jmrix/lenz/liusb/LIUSBAdapter.java
@@ -176,7 +176,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/lenz/ztc640/ZTC640Adapter.java b/java/src/jmri/jmrix/lenz/ztc640/ZTC640Adapter.java
@@ -180,7 +180,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/loconet/Intellibox/IntelliboxAdapter.java b/java/src/jmri/jmrix/loconet/Intellibox/IntelliboxAdapter.java
@@ -60,7 +60,7 @@ public String[] validBaudRates() {
      * Get an array of valid baud rates as integers.
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/loconet/bluetooth/LocoNetBluetoothAdapter.java b/java/src/jmri/jmrix/loconet/bluetooth/LocoNetBluetoothAdapter.java
@@ -239,7 +239,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/loconet/hexfile/LnHexFilePort.java b/java/src/jmri/jmrix/loconet/hexfile/LnHexFilePort.java
@@ -246,7 +246,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return null;
     }
 

diff --git a/java/src/jmri/jmrix/loconet/locobuffer/LocoBufferAdapter.java b/java/src/jmri/jmrix/loconet/locobuffer/LocoBufferAdapter.java
@@ -256,7 +256,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return Arrays.copyOf(validSpeedValues, validSpeedValues.length);
     }
 

diff --git a/java/src/jmri/jmrix/loconet/locobufferii/LocoBufferIIAdapter.java b/java/src/jmri/jmrix/loconet/locobufferii/LocoBufferIIAdapter.java
@@ -24,7 +24,7 @@ public LocoBufferIIAdapter() {
     /**
      * Get an array of valid baud rates. This is modified to have different
      * comments. Because the speeds are the same as the parent class (19200 and
-     * 57600), we don't override validBaudNumber().
+     * 57600), we don't override validBaudNumbers().
      */
     @Override
     public String[] validBaudRates() {

diff --git a/java/src/jmri/jmrix/loconet/locobufferusb/LocoBufferUsbAdapter.java b/java/src/jmri/jmrix/loconet/locobufferusb/LocoBufferUsbAdapter.java
@@ -26,9 +26,9 @@ public LocoBufferUsbAdapter() {
     protected void setSerialPort(SerialPort activeSerialPort) throws UnsupportedCommOperationException {
         // find the baud rate value, configure comm options
         int baud = 19200;  // default, but also defaulted in the initial value of selectedSpeed
-        for (int i = 0; i < validBaudNumber().length; i++) {
+        for (int i = 0; i < validBaudNumbers().length; i++) {
             if (validBaudRates()[i].equals(mBaudRate)) {
-                baud = validBaudNumber()[i];
+                baud = validBaudNumbers()[i];
             }
         }
         activeSerialPort.setSerialPortParams(baud, SerialPort.DATABITS_8,
@@ -58,7 +58,7 @@ public String[] validBaudRates() {
      * change the arrays of speeds.
      */
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{57600};
     }
 

diff --git a/java/src/jmri/jmrix/loconet/ms100/MS100Adapter.java b/java/src/jmri/jmrix/loconet/ms100/MS100Adapter.java
@@ -181,7 +181,7 @@ public String[] validBaudRates() {
     }
 
     @Override
-    public int[] validBaudNumber() {
+    public int[] validBaudNumbers() {
         return new int[]{16600};
     }