From 649258bd2bec43d3b8b6de70e361330be954e33c Mon Sep 17 00:00:00 2001
From: robekl <ekl.rob@gmail.com>
Date: Sat, 25 Apr 2020 04:52:14 -0500
Subject: [PATCH] Fix some minor bugs (#745)

* Include other member variables in copy constructor

* Add break to switch cases

* Implement equals() in classes extending Comparable

If equals() is not overridden, the equals() implementation is not consistent
with the compareTo() implementation. If an object of such a class is added
to a collection such as java.util.SortedSet, this collection will violate
the contract of java.util.Set, which is defined in terms of equals().

Co-authored-by: Rob Ekl <xwq876@zebra.com>
---
 src/main/java/io/github/dsheirer/alias/id/WildcardID.java   | 6 ++++++
 .../io/github/dsheirer/audio/broadcast/AudioRecording.java  | 6 ++++++
 .../io/github/dsheirer/audio/broadcast/BroadcastModel.java  | 1 +
 src/main/java/io/github/dsheirer/bits/BinaryMessage.java    | 2 ++
 .../io/github/dsheirer/channel/state/MultiChannelState.java | 1 +
 .../controller/channel/ChannelProcessingManager.java        | 1 +
 src/main/java/io/github/dsheirer/filter/FilterElement.java  | 6 ++++++
 src/main/java/io/github/dsheirer/icon/Icon.java             | 6 ++++++
 .../io/github/dsheirer/identifier/esn/ESNIdentifier.java    | 6 ++++++
 .../github/dsheirer/identifier/talkgroup/LTRTalkgroup.java  | 6 ++++++
 .../decode/fleetsync2/identifier/FleetsyncIdentifier.java   | 6 ++++++
 .../module/decode/ltrnet/channel/LtrNetChannel.java         | 6 ++++++
 .../decode/ltrnet/identifier/LtrNetRadioIdentifier.java     | 6 ++++++
 .../module/decode/ltrstandard/channel/LtrChannel.java       | 6 ++++++
 .../dsheirer/module/decode/mpt1327/MPT1327Message.java      | 1 +
 .../decode/p25/identifier/channel/P25ExplicitChannel.java   | 6 ++++++
 .../module/decode/p25/phase1/P25P1DecoderState.java         | 2 ++
 .../decode/passport/identifier/PassportTalkgroup.java       | 6 ++++++
 src/main/java/io/github/dsheirer/source/SourceManager.java  | 1 +
 .../java/io/github/dsheirer/source/recording/Recording.java | 6 ++++++
 .../dsheirer/source/tuner/airspy/AirspyTunerEditor.java     | 1 +
 .../github/dsheirer/source/tuner/channel/TunerChannel.java  | 6 ++++++
 22 files changed, 94 insertions(+)

diff --git a/src/main/java/io/github/dsheirer/alias/id/WildcardID.java b/src/main/java/io/github/dsheirer/alias/id/WildcardID.java
index 96d9a60b..2ce8c6da 100644
--- a/src/main/java/io/github/dsheirer/alias/id/WildcardID.java
+++ b/src/main/java/io/github/dsheirer/alias/id/WildcardID.java
@@ -110,4 +110,10 @@ public class WildcardID implements Comparable<WildcardID>
     {
         return Integer.compare(this.weight(), otherWildcardID.weight());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof WildcardID)) return false;
+        return compareTo((WildcardID) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/audio/broadcast/AudioRecording.java b/src/main/java/io/github/dsheirer/audio/broadcast/AudioRecording.java
index 5b70c83a..c9cfac5e 100644
--- a/src/main/java/io/github/dsheirer/audio/broadcast/AudioRecording.java
+++ b/src/main/java/io/github/dsheirer/audio/broadcast/AudioRecording.java
@@ -138,4 +138,10 @@ public class AudioRecording implements Comparable<AudioRecording>
     {
         return mPendingReplayCount.get() > 0;
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof AudioRecording)) return false;
+        return compareTo((AudioRecording) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/audio/broadcast/BroadcastModel.java b/src/main/java/io/github/dsheirer/audio/broadcast/BroadcastModel.java
index 4018032f..0f9d1173 100644
--- a/src/main/java/io/github/dsheirer/audio/broadcast/BroadcastModel.java
+++ b/src/main/java/io/github/dsheirer/audio/broadcast/BroadcastModel.java
@@ -538,6 +538,7 @@ public class BroadcastModel extends AbstractTableModel implements Listener<Audio
                             {
                                 return BroadcastState.INVALID_SETTINGS;
                             }
+                            break;
                         case COLUMN_BROADCASTER_QUEUE_SIZE:
                             AudioBroadcaster audioBroadcasterB = mBroadcasterMap.get(configuration.getName());
 
diff --git a/src/main/java/io/github/dsheirer/bits/BinaryMessage.java b/src/main/java/io/github/dsheirer/bits/BinaryMessage.java
index 68667e7a..7e59046e 100644
--- a/src/main/java/io/github/dsheirer/bits/BinaryMessage.java
+++ b/src/main/java/io/github/dsheirer/bits/BinaryMessage.java
@@ -100,6 +100,8 @@ public class BinaryMessage extends BitSet
         this(toCopyFrom.size());
         this.or(toCopyFrom);
         this.mPointer = toCopyFrom.pointer();
+        this.mCRC = toCopyFrom.mCRC;
+        this.mSize = toCopyFrom.mSize;
     }
 
     public BinaryMessage(BitSet bitset, int size)
diff --git a/src/main/java/io/github/dsheirer/channel/state/MultiChannelState.java b/src/main/java/io/github/dsheirer/channel/state/MultiChannelState.java
index 53010b59..4940b562 100644
--- a/src/main/java/io/github/dsheirer/channel/state/MultiChannelState.java
+++ b/src/main/java/io/github/dsheirer/channel/state/MultiChannelState.java
@@ -531,6 +531,7 @@ public class MultiChannelState extends AbstractChannelState implements IDecoderS
                             ChangeChannelTimeoutEvent timeout = (ChangeChannelTimeoutEvent)event;
                             mStateMachineMap.get(event.getTimeslot()).setFadeTimeoutBuffer(timeout.getCallTimeout());
                         }
+                        break;
                     case CONTINUATION:
                     case DECODE:
                     case START:
diff --git a/src/main/java/io/github/dsheirer/controller/channel/ChannelProcessingManager.java b/src/main/java/io/github/dsheirer/controller/channel/ChannelProcessingManager.java
index 69be2ebe..0cb55217 100644
--- a/src/main/java/io/github/dsheirer/controller/channel/ChannelProcessingManager.java
+++ b/src/main/java/io/github/dsheirer/controller/channel/ChannelProcessingManager.java
@@ -184,6 +184,7 @@ public class ChannelProcessingManager implements Listener<ChannelEvent>
                             break;
                     }
                 }
+                break;
             case NOTIFICATION_DELETE:
                 if(channel.isProcessing())
                 {
diff --git a/src/main/java/io/github/dsheirer/filter/FilterElement.java b/src/main/java/io/github/dsheirer/filter/FilterElement.java
index 76668c4b..394b793c 100644
--- a/src/main/java/io/github/dsheirer/filter/FilterElement.java
+++ b/src/main/java/io/github/dsheirer/filter/FilterElement.java
@@ -46,4 +46,10 @@ public class FilterElement<T> implements Comparable<FilterElement<T>>
     {
 	    return toString().compareTo( other.toString() );
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof FilterElement)) return false;
+        return compareTo((FilterElement) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/icon/Icon.java b/src/main/java/io/github/dsheirer/icon/Icon.java
index 83dca50e..3740aa40 100644
--- a/src/main/java/io/github/dsheirer/icon/Icon.java
+++ b/src/main/java/io/github/dsheirer/icon/Icon.java
@@ -114,4 +114,10 @@ public class Icon implements Comparable<Icon>
     {
         return getName().compareTo(otherIcon.getName());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof Icon)) return false;
+        return compareTo((Icon) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/identifier/esn/ESNIdentifier.java b/src/main/java/io/github/dsheirer/identifier/esn/ESNIdentifier.java
index e83cda6d..223265ac 100644
--- a/src/main/java/io/github/dsheirer/identifier/esn/ESNIdentifier.java
+++ b/src/main/java/io/github/dsheirer/identifier/esn/ESNIdentifier.java
@@ -63,4 +63,10 @@ public class ESNIdentifier extends StringIdentifier implements Comparable<ESNIde
             return getValue().compareTo(o.getValue());
         }
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof ESNIdentifier)) return false;
+        return compareTo((ESNIdentifier) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/identifier/talkgroup/LTRTalkgroup.java b/src/main/java/io/github/dsheirer/identifier/talkgroup/LTRTalkgroup.java
index 71faf302..dd7bbcb1 100644
--- a/src/main/java/io/github/dsheirer/identifier/talkgroup/LTRTalkgroup.java
+++ b/src/main/java/io/github/dsheirer/identifier/talkgroup/LTRTalkgroup.java
@@ -78,4 +78,10 @@ public class LTRTalkgroup extends TalkgroupIdentifier implements Comparable<LTRT
     {
         return getValue().compareTo(o.getValue());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof LTRTalkgroup)) return false;
+        return compareTo((LTRTalkgroup) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/fleetsync2/identifier/FleetsyncIdentifier.java b/src/main/java/io/github/dsheirer/module/decode/fleetsync2/identifier/FleetsyncIdentifier.java
index 2e9c6ea5..f8423b9e 100644
--- a/src/main/java/io/github/dsheirer/module/decode/fleetsync2/identifier/FleetsyncIdentifier.java
+++ b/src/main/java/io/github/dsheirer/module/decode/fleetsync2/identifier/FleetsyncIdentifier.java
@@ -87,4 +87,10 @@ public class FleetsyncIdentifier extends TalkgroupIdentifier implements Comparab
     {
         return getValue().compareTo(o.getValue());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof FleetsyncIdentifier)) return false;
+        return compareTo((FleetsyncIdentifier) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/ltrnet/channel/LtrNetChannel.java b/src/main/java/io/github/dsheirer/module/decode/ltrnet/channel/LtrNetChannel.java
index fe27b3e7..b0fa9f52 100644
--- a/src/main/java/io/github/dsheirer/module/decode/ltrnet/channel/LtrNetChannel.java
+++ b/src/main/java/io/github/dsheirer/module/decode/ltrnet/channel/LtrNetChannel.java
@@ -108,4 +108,10 @@ public class LtrNetChannel implements IChannelDescriptor, Comparable<LtrNetChann
     {
         return Integer.compare(getChannel(), o.getChannel());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof LtrNetChannel)) return false;
+        return compareTo((LtrNetChannel) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/ltrnet/identifier/LtrNetRadioIdentifier.java b/src/main/java/io/github/dsheirer/module/decode/ltrnet/identifier/LtrNetRadioIdentifier.java
index d6d00f08..57a395c7 100644
--- a/src/main/java/io/github/dsheirer/module/decode/ltrnet/identifier/LtrNetRadioIdentifier.java
+++ b/src/main/java/io/github/dsheirer/module/decode/ltrnet/identifier/LtrNetRadioIdentifier.java
@@ -63,4 +63,10 @@ public class LtrNetRadioIdentifier extends TalkgroupIdentifier implements Compar
     {
         return getValue().compareTo(o.getValue());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof LtrNetRadioIdentifier)) return false;
+        return compareTo((LtrNetRadioIdentifier) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/ltrstandard/channel/LtrChannel.java b/src/main/java/io/github/dsheirer/module/decode/ltrstandard/channel/LtrChannel.java
index 2e946a40..d42f7496 100644
--- a/src/main/java/io/github/dsheirer/module/decode/ltrstandard/channel/LtrChannel.java
+++ b/src/main/java/io/github/dsheirer/module/decode/ltrstandard/channel/LtrChannel.java
@@ -102,4 +102,10 @@ public class LtrChannel implements IChannelDescriptor, Comparable<LtrChannel>
     {
         return Integer.compare(getChannel(), o.getChannel());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof LtrChannel)) return false;
+        return compareTo((LtrChannel) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/mpt1327/MPT1327Message.java b/src/main/java/io/github/dsheirer/module/decode/mpt1327/MPT1327Message.java
index 495a199f..be682c93 100644
--- a/src/main/java/io/github/dsheirer/module/decode/mpt1327/MPT1327Message.java
+++ b/src/main/java/io/github/dsheirer/module/decode/mpt1327/MPT1327Message.java
@@ -706,6 +706,7 @@ public class MPT1327Message extends Message
                         sb.append(getPresselOnRequired());
                         sb.append(" IDENT1 VALUE:");
                         sb.append(getMaintMessageIDENT1Value());
+                        break;
                     default:
                         break;
                 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/identifier/channel/P25ExplicitChannel.java b/src/main/java/io/github/dsheirer/module/decode/p25/identifier/channel/P25ExplicitChannel.java
index ba733158..fca4ee5d 100644
--- a/src/main/java/io/github/dsheirer/module/decode/p25/identifier/channel/P25ExplicitChannel.java
+++ b/src/main/java/io/github/dsheirer/module/decode/p25/identifier/channel/P25ExplicitChannel.java
@@ -86,4 +86,10 @@ public class P25ExplicitChannel extends P25Channel implements Comparable<P25Chan
             return Integer.compare(getDownlinkBandIdentifier(), other.getDownlinkBandIdentifier());
         }
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof P25ExplicitChannel)) return false;
+        return compareTo((P25ExplicitChannel) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderState.java b/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderState.java
index f7c1b08b..0c136392 100644
--- a/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderState.java
+++ b/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderState.java
@@ -646,6 +646,7 @@ public class P25P1DecoderState extends DecoderState implements IChannelEventList
                         .details("ANSWER REQUEST")
                         .identifiers(icUUAnswerRequest)
                         .build());
+                    break;
                 case OSP_CALL_ALERT:
                     MutableIdentifierCollection icCallAlert = new MutableIdentifierCollection(getIdentifierCollection().getIdentifiers());
                     icCallAlert.remove(IdentifierClass.USER);
@@ -2122,6 +2123,7 @@ public class P25P1DecoderState extends DecoderState implements IChannelEventList
                             .identifiers(ic)
                             .build());
                     }
+                    break;
                 default:
 //                    mLog.debug("Unrecognized TSBK Opcode: " + tsbk.getOpcode().name() + " VENDOR:" + tsbk.getVendor() +
 //                        " OPCODE:" + tsbk.getOpcodeNumber());
diff --git a/src/main/java/io/github/dsheirer/module/decode/passport/identifier/PassportTalkgroup.java b/src/main/java/io/github/dsheirer/module/decode/passport/identifier/PassportTalkgroup.java
index 85dd728f..20e420f5 100644
--- a/src/main/java/io/github/dsheirer/module/decode/passport/identifier/PassportTalkgroup.java
+++ b/src/main/java/io/github/dsheirer/module/decode/passport/identifier/PassportTalkgroup.java
@@ -66,4 +66,10 @@ public class PassportTalkgroup extends TalkgroupIdentifier implements Comparable
     {
         return Integer.compare(getValue(), o.getValue());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof PassportTalkgroup)) return false;
+        return compareTo((PassportTalkgroup) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/source/SourceManager.java b/src/main/java/io/github/dsheirer/source/SourceManager.java
index 0ff9d40e..15575e8d 100644
--- a/src/main/java/io/github/dsheirer/source/SourceManager.java
+++ b/src/main/java/io/github/dsheirer/source/SourceManager.java
@@ -109,6 +109,7 @@ public class SourceManager
                 break;
             case RECORDING:
                 retVal = mRecordingSourceManager.getSource(config, channelSpecification);
+                break;
             case NONE:
             default:
                 break;
diff --git a/src/main/java/io/github/dsheirer/source/recording/Recording.java b/src/main/java/io/github/dsheirer/source/recording/Recording.java
index 77be419b..e1773c8a 100644
--- a/src/main/java/io/github/dsheirer/source/recording/Recording.java
+++ b/src/main/java/io/github/dsheirer/source/recording/Recording.java
@@ -114,4 +114,10 @@ public class Recording implements Comparable<Recording>, ISourceEventProcessor
 	    return getRecordingConfiguration().getAlias()
 	    		.compareTo( other.getRecordingConfiguration().getAlias() );
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof Recording)) return false;
+        return compareTo((Recording) o) == 0;
+    }
 }
diff --git a/src/main/java/io/github/dsheirer/source/tuner/airspy/AirspyTunerEditor.java b/src/main/java/io/github/dsheirer/source/tuner/airspy/AirspyTunerEditor.java
index c67a2340..c5ef8437 100644
--- a/src/main/java/io/github/dsheirer/source/tuner/airspy/AirspyTunerEditor.java
+++ b/src/main/java/io/github/dsheirer/source/tuner/airspy/AirspyTunerEditor.java
@@ -528,6 +528,7 @@ public class AirspyTunerEditor extends TunerConfigurationEditor
                     mMixerAGC.setEnabled(true);
                     mMixerGain.setEnabled(true);
                 }
+                break;
             default:
                 break;
         }
diff --git a/src/main/java/io/github/dsheirer/source/tuner/channel/TunerChannel.java b/src/main/java/io/github/dsheirer/source/tuner/channel/TunerChannel.java
index 0fb0bd1c..c7def953 100644
--- a/src/main/java/io/github/dsheirer/source/tuner/channel/TunerChannel.java
+++ b/src/main/java/io/github/dsheirer/source/tuner/channel/TunerChannel.java
@@ -88,4 +88,10 @@ public class TunerChannel implements Comparable<TunerChannel>
     {
         return Long.compare(getFrequency(), otherLock.getFrequency());
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof TunerChannel)) return false;
+        return compareTo((TunerChannel) o) == 0;
+    }
 }