IDE Warning Cleanup (Eclipse) - Resolved 350ish IDE warnings from deprecations from Java 8,9, and 10 #2800

HoneySkull · 2021-04-28T02:53:10Z

Resolved several common categories of IDE warnings.

This pull request doesn't correspond to a specific issue or request. Instead is general cleanup of various categories of Eclipse IDE warnings, many resulting from obsolescence of Java 8, 9, and 10 constructs that have been deprecated. It's somewhat important during development to maintain a short list of compiler warnings as numerous warnings cause background noise and mask potential interesting warnings. This pull request contains several commits where I attempted to group each type of warning resolution for easier review.

I used @SuppressWarning sparingly and only in cases where I felt that it made sense to keep the original condition causing the warning such as in 'serialVersionUID' for serializable classes that are Swing GUI components as this is the same tactic used by the Java Swing library.

For the most part, these resolutions were automated by the Eclipse IDE. There are no functional changes to the program from these changes but the end result is resolving all but 12 warning. The remaining warning require at least some investigation (in my opinion) do resolve safely.

Here is a high level of the resolutions:

HexTarget deprecated constructor

Cleaned up Eclipse default IDE warnings for HexTarget. Deprecated
constructor with unused parameter. Cleaned up all calling references to
the non-deprecated constructor.

Default Switch Statement Cases

The IDE's warn against switch statements where all enumeration types are not represented by case statements where no default statement exists. In the context of resolutions here, the enumeration contained many elements and didn't make sense to include all elements in each switch statement. In Java, "default" statements are optional. As such the code here was not incorrect, but generated warnings because not all enum values had cases. Adding the default case expresses the omission of some elements was intended, but more importantly make the compiler happy. :)

Unused Java Import Statements

Over the course of modifying files, it's common for class files to retain Java import statement that are no longer used. Eclipse has a handy Ctrl-Alt-O command that automatically removes and organizes java imports. I do this automatically and instinctively. Now that I stated that, you will see future commits where I forget to do that. (I'm calling it now!)

KeyEvents Deprecated in Java 9 and 10

Keyboard KeyEvents are more expressive in Java 11 and therefore have deprecated many event enumerations and functions for their 'Ex' variety that differentiates between key down and key up events.

Removed unsupported @SuppressWarning statements

I removed a few "unsupported" suppress warning statement that seemed to have no negative side effects when removed. I did not test with IDE's other than Eclipse, I suppose it may be possible that different IDE's utilize these warning types, but assume they are genuinely obsolete. ( I would hate to @SuppressWarning ('unsupported suppresswarning') LOL)

Resolve serialVersionUID for Serializable Java Swing Derived Components

As per the Java Swing library references, I used @SuppressWarning('serial') at-will here.

Unused Variables

Resolve 'unused variable' IDE warnings. Only used SuppressWarning
annotation when appropriate in the context.

MMLogger Deprecated 'error()' Functions

Resolved and removed references and code for deprecated MMLogger::error() functions and removed deprecated functions from the class. I did not however, clean up the '::info' or other deprecated functions in this class but should have. It appears that most deprecated functions in the MMLogger class can now be safely eradicated.

Merge from origin/master

constructor with unused parameter. Cleaned up all calling references to the non-depricated constructor.

eclipse IDE warning messages due to the fact that not all enum types were cased in the switch statement. The default case is optional, but will generate compiler warnings to alert the programmer to potential missing enum types.

remove Java IDE compiler warnings from Java 11.

annotations to classes derived from Swing components. This is what they do in the Swing library base classes.

annotation when appropriate in the context.

MMLogger::error functions.

…IDE_Warning_Cleanup

HoneySkull · 2021-04-28T03:55:40Z

megamek/unittests/megamek/client/bot/princess/NewtonAerospacePathRankerTest.java

+    @SuppressWarnings("unused")
+	private Princess mockPrincess;
+    @SuppressWarnings("unused")
+	private NewtonianAerospacePathRanker mockPathRanker;
+    @SuppressWarnings("unused")
+	private IGame mockGame;
+    @SuppressWarnings("unused")
+	private GameOptions mockGameOptions;


These private variables are part of a 'broken' jUnit test that had it's test method bodies commented out. My first instinct beyond just deleting the entire broken test was to comment these variables out also to resolve the unused variable warning, however, I felt if keeping the test, it's better to apply the suppress warning to say, "fix me or delete me." '@SuppressWarning("unused");' is searchable.

Windchild292 · 2021-04-28T13:58:31Z

megamek/src/megamek/client/ui/baseComponents/AbstractSplitPane.java

+import java.awt.Component;
+import java.util.ResourceBundle;
+
+import javax.swing.JFrame;
+import javax.swing.JSplitPane;


We allow wildcard imports, especially for AWT and Swing

Otherwise they're a nightmare!

This was done automatically by Eclipse Ctrl-Shift-O that 'organizes' imports... I'll revert this and clean it up manually when I split this into it's own pull request.

Windchild292 · 2021-04-28T13:59:58Z

megamek/src/megamek/client/ui/baseComponents/AbstractButtonDialog.java

@@ -42,6 +42,7 @@
 * This is directly tied to MekHQ's AbstractMHQButtonDialog, and any changes here MUST be verified
 * there.
 */
+@SuppressWarnings("serial") // Same-version serialization only (See Swing base classes)


This is completely IDE setup dependent. My IDE (IDEA) gives me the exact opposite warning, mentioning that the suppression is redundant. Further, we do not employ serialization in any of our components.

VSCode complains about this being unnecessary too.

I will revert this set of change. I had a suspicion that these were IDE specific. I can change my IDE settings to accommodate. I don't want to simply move the warning from one environment to another. :)

Windchild292

Few comments and queries first.

Also, did you test this with MekHQ? We still use a bunch of deprecated logger functionalities there, and I'm pretty sure this will break that.

Finally, we use four spaces for spacing, not tabs. I noted a few places where this was not the case in the changes.

Windchild292 · 2021-04-28T14:03:08Z

megamek/src/megamek/client/ui/swing/StatusBarPhaseDisplay.java

@@ -59,8 +58,6 @@
        implements ActionListener, MouseListener, KeyListener, IPreferenceChangeListener {

    //L4J Support


Can remove this comment too.

Windchild292 · 2021-04-28T14:04:49Z

megamek/src/megamek/common/FixedWingSupport.java

@@ -417,6 +417,7 @@ public double getPriceMultiplier() {
            case STATION_KEEPING:
                priceMultiplier = 1 + weight / 75.0;
                break;
+            default:


Better would be

default: break;

Yep! My bad. Don't want somebody accidentally adding a case statement below the default and have it fall through unintended.

Windchild292 · 2021-04-28T14:07:13Z

megamek/src/megamek/server/Server.java

@@ -27973,7 +28018,7 @@ else if ((null != Compute.stackingViolation(game, other.getId(), curPos))
     * Possible to override 'is explosive' check
     */
    public Vector<Report> explodeEquipment(Entity en, int loc, Mounted mounted, boolean overrideExplosiveCheck) {
-        final String METHOD_NAME = "explodeEquipment(Entity,int,Mounted)";
+        //final String METHOD_NAME = "explodeEquipment(Entity,int,Mounted)";


Just remove this, don't comment it out.

sixlettervariables

Please break this into separate pull requests based on the class of warning or message being resolved. Otherwise this is merge conflict city for other work.

HoneySkull · 2021-04-28T16:22:32Z

@sixlettervariables - I will break this into individual pull requests by warning type with the feedback from this PR. What should I do with this PR? Cancel/Close? Convert to draft?

sixlettervariables · 2021-04-28T16:25:54Z

You can use this branch for a specific type of warning or close it in favor of other PRs. No preference.

HoneySkull · 2021-04-28T16:45:53Z

@Windchild292 - I did not test with MekHQ or MekLab - it didn't occur to me that those projects have a direct dependency on MegaMek. The intent of this pull request was to resolve the warnings in MegaMek, so I will leave MMLogger as is. I over reached by removing the methods. Does it make sense to pull common code into a separate MM project?

Windchild292 · 2021-04-28T17:08:43Z

MekHQ relies on a pretty spread out grouping of code originating in MegaMek and MegaMekLab, so it really does not make sense to do so. Utilities like the logger are more likely to be shared between the two, but we also reuse some graphical components and similar.

…aMek#2819 MegaMek#2800

HoneySkull · 2021-05-05T05:51:29Z

The majority of these have been completed under separate pull requests.

Root fix for Left click issues including movement and LOS issues. #2819, #2800

HoneySkull and others added 11 commits April 24, 2021 02:08

Merge pull request #1 from MegaMek/master

777fb9f

Merge from origin/master

Merge remote-tracking branch 'upstream/master'

14a619f

Clean up Eclipse default IDE warnings for HexTarget. Depricated

a8c8daa

constructor with unused parameter. Cleaned up all calling references to the non-depricated constructor.

Clean up unused java imports.

c32b2b9

Updated KeyEvent modifiers that were deprecated in Java 9 or 10 to

b73bcbb

remove Java IDE compiler warnings from Java 11.

Removed unsupported supresswarnings generated in Eclipse IDE /w Java 11.

0c476e2

Removed serialVersionUID compiler warnings. Added Suppresswarning

6d74622

annotations to classes derived from Swing components. This is what they do in the Swing library base classes.

Resolve 'unused variable' IDE warnings. Only used SuppressWarning

94f430e

annotation when appropriate in the context.

Resolve deprecated IDE warnings for MMLogger. Cleaned up deprecated

547656d

MMLogger::error functions.

Merge branch 'master' of https://github.com/MegaMek/megamek.git into …

6590a95

…IDE_Warning_Cleanup

HoneySkull commented Apr 28, 2021

View reviewed changes

Windchild292 reviewed Apr 28, 2021

View reviewed changes

sixlettervariables suggested changes Apr 28, 2021

View reviewed changes

HoneySkull added a commit to HoneySkull/megamek that referenced this pull request May 5, 2021

Root fix for Left click issues including movement and LOS issues. Meg…

bc2ef9a

…aMek#2819 MegaMek#2800

HoneySkull closed this May 5, 2021

NickAragua added a commit that referenced this pull request May 6, 2021

Merge pull request #2836 from HoneySkull/KeyEvent_Fix

efcab7a

Root fix for Left click issues including movement and LOS issues. #2819, #2800

HoneySkull added a commit to HoneySkull/megamek that referenced this pull request May 13, 2021

Fixed Board Editor Level UP/DOWN as was broken with MegaMek#2800.

e29b4a6

HoneySkull added a commit to HoneySkull/megamek that referenced this pull request May 13, 2021

Fixed board editor left mouse dragging issue caused by MegaMek#2800

f21d6f8

This was referenced May 13, 2021

Board Editor Level Up/Dn and left-click drag broken. #2856

Closed

Fixed Board Editor Level Up/Dn and left click dragging to work like .48 #2856 #2857

Merged

HoneySkull deleted the IDE_Warning_Cleanup branch May 18, 2023 03:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IDE Warning Cleanup (Eclipse) - Resolved 350ish IDE warnings from deprecations from Java 8,9, and 10 #2800

IDE Warning Cleanup (Eclipse) - Resolved 350ish IDE warnings from deprecations from Java 8,9, and 10 #2800

HoneySkull commented Apr 28, 2021 •

edited

Loading

HoneySkull Apr 28, 2021

Windchild292 Apr 28, 2021

sixlettervariables Apr 28, 2021

HoneySkull Apr 28, 2021

Windchild292 Apr 28, 2021

sixlettervariables Apr 28, 2021 •

edited

Loading

HoneySkull Apr 28, 2021

Windchild292 left a comment

Windchild292 Apr 28, 2021

Windchild292 Apr 28, 2021

HoneySkull Apr 28, 2021

Windchild292 Apr 28, 2021

sixlettervariables left a comment

HoneySkull commented Apr 28, 2021

sixlettervariables commented Apr 28, 2021

HoneySkull commented Apr 28, 2021

Windchild292 commented Apr 28, 2021

HoneySkull commented May 5, 2021

		@@ -59,8 +58,6 @@
		implements ActionListener, MouseListener, KeyListener, IPreferenceChangeListener {

		//L4J Support

IDE Warning Cleanup (Eclipse) - Resolved 350ish IDE warnings from deprecations from Java 8,9, and 10 #2800

IDE Warning Cleanup (Eclipse) - Resolved 350ish IDE warnings from deprecations from Java 8,9, and 10 #2800

Conversation

HoneySkull commented Apr 28, 2021 • edited Loading

Resolved several common categories of IDE warnings.

HexTarget deprecated constructor

Default Switch Statement Cases

Unused Java Import Statements

KeyEvents Deprecated in Java 9 and 10

Removed unsupported @SuppressWarning statements

Resolve serialVersionUID for Serializable Java Swing Derived Components

Unused Variables

MMLogger Deprecated 'error()' Functions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sixlettervariables Apr 28, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Windchild292 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sixlettervariables left a comment

Choose a reason for hiding this comment

HoneySkull commented Apr 28, 2021

sixlettervariables commented Apr 28, 2021

HoneySkull commented Apr 28, 2021

Windchild292 commented Apr 28, 2021

HoneySkull commented May 5, 2021

HoneySkull commented Apr 28, 2021 •

edited

Loading

sixlettervariables Apr 28, 2021 •

edited

Loading