Merge pull request #6463 from danielb987/make_methods_final_2

Make AbstractNamedBean.toString() final
JMRI · Feb 13, 2020 · 0f3f176 · 0f3f176
2 parents 01da3b8 + eb9e9af
commit 0f3f176
Show file tree

Hide file tree

Showing 27 changed files with 24 additions and 116 deletions.
diff --git a/java/src/jmri/implementation/AbstractAudio.java b/java/src/jmri/implementation/AbstractAudio.java
@@ -48,11 +48,6 @@ public void setState(int newState) {
         firePropertyChange("State", _old, _state); //NOI18N
     }
 
-    @Override
-    public String toString() {
-        return this.getClass().getName() + " (" + this.getSystemName() + ")"; //NOI18N
-    }
-
     /**
      * Abstract method that concrete classes will implement to perform necessary
      * cleanup routines.

diff --git a/java/src/jmri/implementation/AbstractNamedBean.java b/java/src/jmri/implementation/AbstractNamedBean.java
@@ -258,16 +258,10 @@ final public String getSystemName() {
         return mSystemName;
     }
 
-    /**
-     * {@inheritDoc}
-     * <p>
-     * It would be good to eventually make this final to 
-     * keep it consistent system-wide, but 
-     * we have some existing classes to update first.
-     */
+    /** {@inheritDoc} */
     @Nonnull
     @Override
-    public String toString() {
+    final public String toString() {
         return getSystemName();
     }
 

diff --git a/java/src/jmri/implementation/AbstractStringIO.java b/java/src/jmri/implementation/AbstractStringIO.java
@@ -127,11 +127,4 @@ public int compareSystemNameSuffix(@Nonnull String suffix1, @Nonnull String suff
         return suffix1.compareTo(suffix2);
     }
 
-    /** {@inheritDoc} */
-    @Override
-    @Nonnull
-    public String toString() {
-        return this.getClass().getName() + " (" + this.getSystemName() + ")"; //NOI18N
-    }
-
 }
diff --git a/java/src/jmri/implementation/DefaultSignalSystem.java b/java/src/jmri/implementation/DefaultSignalSystem.java
@@ -177,27 +177,6 @@ public float getMaximumLineSpeed() {
 
     protected java.util.Vector<String> imageTypes = new java.util.Vector<>();
 
-    // note that this doesn't properly implement the 
-    // contract in {@link NamedBean.toString()}, 
-    // which means things like tables and persistance 
-    // might not behave properly.
-    @Override
-    public String toString() {
-        StringBuilder retval = new StringBuilder();
-        retval.append("SignalSystem ").append(getSystemName()).append("\n");
-        Enumeration<String> e1 = getAspects();
-        while (e1.hasMoreElements()) {
-            String s1 = e1.nextElement();
-            retval.append("  ").append(s1).append("\n");
-            Enumeration<String> e2 = getKeys();
-            while (e2.hasMoreElements()) {
-                String s2 = e2.nextElement();
-                retval.append("    ").append(s2).append(": ").append(getProperty(s1, s2)).append("\n");
-            }
-        }
-        return retval.toString();
-    }
-
     @Override
     public String getBeanType() {
         return Bundle.getMessage("BeanNameSignalSystem");

diff --git a/java/src/jmri/jmrit/audio/AbstractAudioListener.java b/java/src/jmri/jmrit/audio/AbstractAudioListener.java
@@ -228,13 +228,6 @@ public void stateChanged(int oldState) {
         // Move along... nothing to see here...
     }
 
-    @Override
-    public String toString() {
-        return "Pos: " + this.getPosition().toString()
-                + ", gain=" + this.getGain()
-                + ", meters/unit=" + this.getMetersPerUnit();
-    }
-
     private static final Logger log = LoggerFactory.getLogger(AbstractAudioListener.class);
 
     /**

diff --git a/java/src/jmri/jmrit/audio/AbstractAudioSource.java b/java/src/jmri/jmrit/audio/AbstractAudioSource.java
@@ -845,13 +845,9 @@ protected int getFading() {
         return this.fading;
     }
 
-    // note that this doesn't properly implement the 
-    // contract in {@link NamedBean.toString()}, 
-    // which means things like tables and persistance 
-    // might not behave properly.
     @Override
     @Nonnull
-    public String toString() {
+    public String getDebugString() {
         return "Pos: " + this.getPosition().toString()
                 + ", bound to: " + this.getAssignedBufferName()
                 + ", loops: "

diff --git a/java/src/jmri/jmrit/audio/AudioSource.java b/java/src/jmri/jmrit/audio/AudioSource.java
@@ -849,4 +849,14 @@ default public void setDopplerFactor(float dopplerFactor) {}
      */
     public void fadeOut();
 
+    /**
+     * Get debug info about this audio source.
+     * AbstractAudioSource overrides this to get more debug info. It was
+     * previously the method toString().
+     * @return a string with debug info or the result of the method toString()
+     */
+    default public String getDebugString() {
+        return toString();
+    }
+
 }
diff --git a/java/src/jmri/jmrit/audio/JavaSoundAudioBuffer.java b/java/src/jmri/jmrit/audio/JavaSoundAudioBuffer.java
@@ -132,15 +132,6 @@ protected AudioFormat getAudioFormat() {
         return audioFormat;
     }
 
-    @Override
-    public String toString() {
-        if (this.getState() != STATE_LOADED) {
-            return "Empty buffer";
-        } else {
-            return this.getURL() + " (" + parseFormat() + ", " + this.freq + " Hz)";
-        }
-    }
-
     @Override
     protected boolean loadBuffer(InputStream stream) {
         if (!initialised) {

diff --git a/java/src/jmri/jmrit/audio/JavaSoundAudioSource.java b/java/src/jmri/jmrit/audio/JavaSoundAudioSource.java
@@ -533,10 +533,10 @@ protected void setGain(float gain) {
 
                 this.gainControl.setValue(dB);
                 if (log.isDebugEnabled()) {
-                    log.debug("Actual gain value of JavaSoundAudioSource {} is {}", this.audio, this.gainControl.getValue());
+                    log.debug("Actual gain value of JavaSoundAudioSource {} is {}", this.audio.getDebugString(), this.gainControl.getValue());
                 }
             }
-            log.debug("Set gain of JavaSoundAudioSource {} to {}", this.audio, gain);
+            log.debug("Set gain of JavaSoundAudioSource {} to {}", this.audio.getDebugString(), gain);
         }
 
         /**
@@ -548,7 +548,7 @@ protected void setPan(float pan) {
             if (this.panControl != null) {
                 this.panControl.setValue(pan);
             }
-            log.debug("Set pan of JavaSoundAudioSource {} to {}", this.audio, pan);
+            log.debug("Set pan of JavaSoundAudioSource {} to {}", this.audio.getDebugString(), pan);
         }
 
         /**
@@ -562,7 +562,7 @@ protected void setPitch(float pitch) {
             if (this.sampleRateControl != null) {
                 this.sampleRateControl.setValue(pitch * this.initialSampleRate);
             }
-            log.debug("Set pitch of JavaSoundAudioSource {} to {}", this.audio, pitch);
+            log.debug("Set pitch of JavaSoundAudioSource {} to {}", this.audio.getDebugString(), pitch);
         }
 
     }

diff --git a/java/src/jmri/jmrit/audio/JoalAudioBuffer.java b/java/src/jmri/jmrit/audio/JoalAudioBuffer.java
@@ -141,15 +141,6 @@ protected int[] getDataStorageBuffer() {
         return dataStorageBuffer;
     }
 
-    @Override
-    public String toString() {
-        if (this.getState() != STATE_LOADED) {
-            return "Empty buffer";
-        } else {
-            return this.getURL() + " (" + parseFormat() + ", " + this.freq[0] + " Hz)";
-        }
-    }
-
     /**
      * Internal method to return a string representation of the audio format
      *

diff --git a/java/src/jmri/jmrit/audio/NullAudioBuffer.java b/java/src/jmri/jmrit/audio/NullAudioBuffer.java
@@ -50,15 +50,6 @@ public NullAudioBuffer(String systemName, String userName) {
         }
     }
 
-    @Override
-    public String toString() {
-        if (this.getState() != STATE_LOADED) {
-            return "Empty buffer";
-        } else {
-            return this.getURL() + " (" + parseFormat() + ", " + "?? Hz)";
-        }
-    }
-
     @Override
     protected boolean loadBuffer(InputStream stream) {
         // No need to do this for the NullAudioBuffer - it's always successful ;-)
@@ -104,15 +95,6 @@ public int getFrequency() {
         return 0;
     }
 
-    /**
-     * Internal method to return a string representation of the audio format
-     *
-     * @return string representation
-     */
-    private String parseFormat() {
-        return "unknown format";
-    }
-
     @Override
     protected void cleanup() {
         if (log.isDebugEnabled()) {

diff --git a/java/src/jmri/jmrix/loconet/TranspondingTag.java b/java/src/jmri/jmrix/loconet/TranspondingTag.java
@@ -28,20 +28,4 @@ public TranspondingTag(String systemName, String userName) {
         super(systemName, userName);
     }
 
-    /**
-     * @deprecated since 4.15.4.  Eventually will be removed in favor of
-     * the {@link jmri.implementation.AbstractNamedBean#toString()}, which 
-     * does not produce the same result. Use {@link #toReportString()} instead.
-     */
-    @Deprecated
-    @Override
-    public String toString(){
-       String exit = (String) getProperty("entryexit");
-       if(exit!=null) {
-          return getTagID() + " " + exit;
-       } else {
-          return getTagID();
-       }
-    }
-
 }
diff --git a/java/test/jmri/implementation/AbstractAudioTest.java b/java/test/jmri/implementation/AbstractAudioTest.java
@@ -26,8 +26,7 @@ public void testState() {
         Assert.assertTrue("state is playing", audio.getState() == jmri.Audio.STATE_PLAYING);
         // Check that audio.setState() triggers stateChanged()
         Assert.assertTrue("state has changed", stateHasChanged.get());
-        Assert.assertTrue("toString() matches",
-                "jmri.implementation.AbstractAudioTest$MyAbstractAudio (MySystemName)".equals(audio.toString()));
+        Assert.assertEquals("toString() matches", "MySystemName", audio.toString());
 
         Assert.assertTrue("getBeanType() matches", "Audio".equals(audio.getBeanType()));
     }

diff --git a/java/test/jmri/implementation/AbstractStringIOTest.java b/java/test/jmri/implementation/AbstractStringIOTest.java
@@ -75,8 +75,7 @@ public void testStringIO() throws JmriException {
         Assert.assertTrue("string is cut",
                 "8:20. Trai".equals(myStringIO.getKnownStringValue()));
 
-        Assert.assertTrue("toString() matches",
-                "jmri.implementation.AbstractStringIOTest$MyAbstractStringIO (IZMySystemName)".equals(myStringIO.toString()));
+        Assert.assertEquals("toString() matches", "IZMySystemName", myStringIO.toString());
 
         Assert.assertTrue("getBeanType() matches", "String I/O".equals(myStringIO.getBeanType()));
     }

diff --git a/java/test/jmri/jmrit/audio/JoalAudioBufferTest.java b/java/test/jmri/jmrit/audio/JoalAudioBufferTest.java
@@ -33,7 +33,7 @@ public void testC2Stringtor() {
         Assert.assertNotNull("exists", l);
         Assert.assertEquals("testsysname", l.getSystemName());
         Assert.assertEquals("testusername", l.getUserName());
-        Assert.assertEquals("Empty buffer", l.toString());
+        Assert.assertEquals("testsysname", l.toString());
         Assert.assertEquals(0, l.getLength());
     }
 

diff --git a/java/test/jmri/jmrix/loconet/LnReporterTest.java b/java/test/jmri/jmrix/loconet/LnReporterTest.java
@@ -98,7 +98,7 @@ public void testMessageFromManagerFindReport() {
                 7, r.getState());
 
         Assert.assertEquals("MessageFromManagerFindReport- check report string after message 1", 
-                "7 enter", r.getCurrentReport().toString() );
+                "7 enter", ((Reportable)r.getCurrentReport()).toReportString() );
 
         Assert.assertEquals("MessageFromManagerFindReport- check last loco after message 1",
                 7, ((LnReporter)r).lastLoco);

diff --git a/java/test/jmri/jmrix/loconet/TranspondingTagTest.java b/java/test/jmri/jmrix/loconet/TranspondingTagTest.java
@@ -40,13 +40,15 @@ public void testTranspondingTagToString() {
         TranspondingTag r = new TranspondingTag("ID1234");
         // set the entryexit property
         r.setProperty("entryexit","exits");
-        Assert.assertEquals("TranspondingTag toString ", "1234 exits", r.toString());
+        Assert.assertEquals("TranspondingTag toString ", "ID1234", r.toString());
     }
 
     @Test
     public void testTranspondingTagToReportString() {
         TranspondingTag r = new TranspondingTag("LD1234");
         Assert.assertEquals("TranspondingTag toReportString ", "1234", r.toReportString());
+        r.setProperty("entryexit","exits");
+        Assert.assertEquals("TranspondingTag toReportString ", "1234 exits", r.toReportString());
     }
 
     @Test

diff --git a/jython/serialinput/Sensor_Channel_To_JMRI/JMRISensorScanMega.ino b/jython/serialinput/Sensor_Channel_To_JMRI/JMRISensorScanMega.ino
diff --git a/jython/serialinput/Sensor_Channel_To_JMRI/JMRISensorScanUNO.ino b/jython/serialinput/Sensor_Channel_To_JMRI/JMRISensorScanUNO.ino
diff --git a/jython/serialinput/Sensor_Channel_To_JMRI/SensorSerialClose.py b/jython/serialinput/Sensor_Channel_To_JMRI/SensorSerialClose.py
diff --git a/jython/serialinput/Sensor_Channel_To_JMRI/Sensor_Channels_Readme.md b/jython/serialinput/Sensor_Channel_To_JMRI/Sensor_Channels_Readme.md
diff --git a/jython/serialinput/Sensor_Channel_To_JMRI/Sensor_Scan.py b/jython/serialinput/Sensor_Channel_To_JMRI/Sensor_Scan.py
diff --git a/jython/serialinput/Turnout_Channel_from_JMRI/JMRITurnoutScanMega.ino b/jython/serialinput/Turnout_Channel_from_JMRI/JMRITurnoutScanMega.ino
diff --git a/jython/serialinput/Turnout_Channel_from_JMRI/JMRITurnoutScanUno.ino b/jython/serialinput/Turnout_Channel_from_JMRI/JMRITurnoutScanUno.ino
diff --git a/jython/serialinput/Turnout_Channel_from_JMRI/TurnoutDataTransfer.py b/jython/serialinput/Turnout_Channel_from_JMRI/TurnoutDataTransfer.py
diff --git a/jython/serialinput/Turnout_Channel_from_JMRI/Turnout_Channels_Readme.md b/jython/serialinput/Turnout_Channel_from_JMRI/Turnout_Channels_Readme.md
diff --git a/jython/serialinput/Turnout_Channel_from_JMRI/Turnout_Table_Build.py b/jython/serialinput/Turnout_Channel_from_JMRI/Turnout_Table_Build.py