Use Java 17 language features (#1206)

MarkEWaite · web-flow · commit b7418601412f · 2024-10-21T15:36:34.000-06:00
instanceof pattern matching Add @serial annotation
diff --git a/src/main/java/hudson/plugins/git/Branch.java b/src/main/java/hudson/plugins/git/Branch.java
@@ -1,5 +1,6 @@
 package hudson.plugins.git;
 
+import java.io.Serial;
 import java.util.Objects;
 import org.eclipse.jgit.lib.ObjectId;
 import org.eclipse.jgit.lib.Ref;
@@ -8,6 +9,7 @@
  * Represents a git branch.
  */
 public class Branch extends GitObject {
+    @Serial
     private static final long serialVersionUID = 1L;
 
     /**
diff --git a/src/main/java/hudson/plugins/git/GitAPI.java b/src/main/java/hudson/plugins/git/GitAPI.java
@@ -28,7 +28,9 @@
  */
 @Deprecated
 public class GitAPI extends CliGitAPIImpl {
+    @Serial
     private static final long serialVersionUID = 1L;
+
     private final GitClient jgit;
 
     /**
diff --git a/src/main/java/hudson/plugins/git/GitException.java b/src/main/java/hudson/plugins/git/GitException.java
@@ -1,11 +1,14 @@
 package hudson.plugins.git;
 
+import java.io.Serial;
+
 /**
  * Records exception information related to git operations. This exception is
  * used to encapsulate command line git errors, JGit errors, and other errors
  * related to git operations.
  */
 public class GitException extends RuntimeException {
+    @Serial
     private static final long serialVersionUID = 1L;
 
     /**
diff --git a/src/main/java/hudson/plugins/git/GitLockFailedException.java b/src/main/java/hudson/plugins/git/GitLockFailedException.java
@@ -1,10 +1,13 @@
 package hudson.plugins.git;
 
+import java.io.Serial;
+
 /**
  * Exception which reports failure to lock a git repository. Lock failures are
  * a special case and may indicate that a retry attempt might succeed.
  */
 public class GitLockFailedException extends GitException {
+    @Serial
     private static final long serialVersionUID = 1L;
 
     /**
diff --git a/src/main/java/hudson/plugins/git/GitObject.java b/src/main/java/hudson/plugins/git/GitObject.java
@@ -1,6 +1,7 @@
 package hudson.plugins.git;
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.Serial;
 import java.io.Serializable;
 import java.util.Objects;
 import org.eclipse.jgit.lib.ObjectId;
@@ -14,6 +15,7 @@
 @ExportedBean(defaultVisibility = 999)
 public class GitObject implements Serializable {
 
+    @Serial
     private static final long serialVersionUID = 1L;
 
     final ObjectId sha1;
diff --git a/src/main/java/hudson/plugins/git/GitTool.java b/src/main/java/hudson/plugins/git/GitTool.java
@@ -17,6 +17,7 @@
 import hudson.util.FormValidation;
 import java.io.File;
 import java.io.IOException;
+import java.io.Serial;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -53,6 +54,7 @@ public GitTool(String name, String home, List<? extends ToolProperty<?>> propert
     /** Constant <code>DEFAULT="Default"</code> */
     public static final transient String DEFAULT = "Default";
 
+    @Serial
     private static final long serialVersionUID = 1;
 
     /**
diff --git a/src/main/java/hudson/plugins/git/IndexEntry.java b/src/main/java/hudson/plugins/git/IndexEntry.java
@@ -1,5 +1,6 @@
 package hudson.plugins.git;
 
+import java.io.Serial;
 import java.io.Serializable;
 import java.util.Objects;
 import org.eclipse.jgit.submodule.SubmoduleWalk;
@@ -155,5 +156,6 @@ public IndexEntry(SubmoduleWalk walk) {
         this("160000", "commit", walk.getObjectId().name(), walk.getPath());
     }
 
+    @Serial
     private static final long serialVersionUID = 1L;
 }
diff --git a/src/main/java/hudson/plugins/git/Revision.java b/src/main/java/hudson/plugins/git/Revision.java
@@ -4,6 +4,7 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Util;
+import java.io.Serial;
 import java.util.ArrayList;
 import java.util.Collection;
 import org.eclipse.jgit.lib.ObjectId;
@@ -19,6 +20,7 @@
  */
 @ExportedBean(defaultVisibility = 999)
 public class Revision implements java.io.Serializable, Cloneable {
+    @Serial
     private static final long serialVersionUID = -7203898556389073882L;
 
     ObjectId sha1;
diff --git a/src/main/java/hudson/plugins/git/Tag.java b/src/main/java/hudson/plugins/git/Tag.java
@@ -1,12 +1,14 @@
 package hudson.plugins.git;
 
+import java.io.Serial;
 import java.util.Objects;
 import org.eclipse.jgit.lib.ObjectId;
 
 /**
  * Git tag including SHA1 and message of the associated commit.
  */
 public class Tag extends GitObject {
+    @Serial
     private static final long serialVersionUID = 1L;
     /** SHA1 hash of the tagged commit */
     public String commitSHA1;
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java b/src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java
@@ -183,7 +183,9 @@ public class CliGitAPIImpl extends LegacyCompatibleGitAPIImpl {
 
     private static final Logger LOGGER = Logger.getLogger(CliGitAPIImpl.class.getName());
 
+    @Serial
     private static final long serialVersionUID = 1;
+
     static final String SPARSE_CHECKOUT_FILE_DIR = ".git/info";
     static final String SPARSE_CHECKOUT_FILE_PATH = ".git/info/sparse-checkout";
     static final String TIMEOUT_LOG_PREFIX = " # timeout=";
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/Git.java b/src/main/java/org/jenkinsci/plugins/gitclient/Git.java
@@ -8,6 +8,7 @@
 import hudson.remoting.VirtualChannel;
 import java.io.File;
 import java.io.IOException;
+import java.io.Serial;
 import java.io.Serializable;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
@@ -177,6 +178,7 @@ private GitClient initMockClient(String className, String exe, EnvVars env, File
     public static final boolean USE_CLI =
             Boolean.parseBoolean(System.getProperty(Git.class.getName() + ".useCLI", "true"));
 
+    @Serial
     private static final long serialVersionUID = 1L;
 
     private class GitAPIMasterToSlaveFileCallable extends jenkins.MasterToSlaveFileCallable<GitClient> {
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/JGitAPIImpl.java b/src/main/java/org/jenkinsci/plugins/gitclient/JGitAPIImpl.java
@@ -35,6 +35,7 @@
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.PrintWriter;
+import java.io.Serial;
 import java.io.StringWriter;
 import java.io.Writer;
 import java.net.URISyntaxException;
@@ -151,7 +152,9 @@
  * @author Kohsuke Kawaguchi
  */
 public class JGitAPIImpl extends LegacyCompatibleGitAPIImpl {
+    @Serial
     private static final long serialVersionUID = 1L;
+
     private static final Logger LOGGER = Logger.getLogger(JGitAPIImpl.class.getName());
 
     private final TaskListener listener;
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/JGitApacheTool.java b/src/main/java/org/jenkinsci/plugins/gitclient/JGitApacheTool.java
@@ -4,6 +4,7 @@
 import hudson.Extension;
 import hudson.plugins.git.GitTool;
 import hudson.tools.ToolProperty;
+import java.io.Serial;
 import java.util.Collections;
 import java.util.List;
 import org.jenkinsci.Symbol;
@@ -13,6 +14,7 @@
  * JGit, configured with the Apache HTTP Client, as {@link hudson.plugins.git.GitTool}
  */
 public class JGitApacheTool extends GitTool {
+    @Serial
     private static final long serialVersionUID = 1L;
 
     @DataBoundConstructor
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/JGitTool.java b/src/main/java/org/jenkinsci/plugins/gitclient/JGitTool.java
@@ -4,6 +4,7 @@
 import hudson.Extension;
 import hudson.plugins.git.GitTool;
 import hudson.tools.ToolProperty;
+import java.io.Serial;
 import java.util.Collections;
 import java.util.List;
 import org.jenkinsci.Symbol;
@@ -15,6 +16,7 @@
  * @author Kohsuke Kawaguchi
  */
 public class JGitTool extends GitTool {
+    @Serial
     private static final long serialVersionUID = 1L;
 
     /**
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/RemoteGitImpl.java b/src/main/java/org/jenkinsci/plugins/gitclient/RemoteGitImpl.java
@@ -18,6 +18,7 @@
 import hudson.remoting.RemoteWriter;
 import java.io.IOException;
 import java.io.OutputStream;
+import java.io.Serial;
 import java.io.Serializable;
 import java.io.Writer;
 import java.lang.reflect.InvocationHandler;
@@ -107,6 +108,7 @@ public void replay(Object target) throws InvocationTargetException, IllegalAcces
                     "Method not found: " + methodName + "(" + String.join(",", parameterTypes) + ")");
         }
 
+        @Serial
         private static final long serialVersionUID = 1L;
     }
 
@@ -156,6 +158,7 @@ public void execute() throws GitException, InterruptedException {
             }
         }
 
+        @Serial
         private static final long serialVersionUID = 1L;
 
         private class GitCommandMasterToSlaveCallable
@@ -1043,6 +1046,7 @@ public void setProxy(ProxyConfiguration proxyConfiguration) {
         proxy.setProxy(proxyConfiguration);
     }
 
+    @Serial
     private static final long serialVersionUID = 1L;
 
     /** {@inheritDoc} */
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/jgit/SmartCredentialsProvider.java b/src/main/java/org/jenkinsci/plugins/gitclient/jgit/SmartCredentialsProvider.java
@@ -169,10 +169,9 @@ public boolean get(URIish uri, CredentialItem... credentialItems) throws Unsuppo
                 password.setValue(credentials.getPassword().getPlainText().toCharArray());
                 continue;
             }
-            if (i instanceof CredentialItem.StringType) {
+            if (i instanceof CredentialItem.StringType t) {
                 if (i.getPromptText().equals("Password: ") && c instanceof PasswordCredentials credentials) {
-                    ((CredentialItem.StringType) i)
-                            .setValue(credentials.getPassword().getPlainText());
+                    t.setValue(credentials.getPassword().getPlainText());
                     continue;
                 }
             }
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/verifier/NoHostKeyVerifier.java b/src/main/java/org/jenkinsci/plugins/gitclient/verifier/NoHostKeyVerifier.java
@@ -1,6 +1,7 @@
 package org.jenkinsci.plugins.gitclient.verifier;
 
 import hudson.model.TaskListener;
+import java.io.Serial;
 import java.util.logging.Logger;
 import org.eclipse.jgit.transport.sshd.ServerKeyDatabase;
 
@@ -23,6 +24,7 @@ public static class NoHostJGitKeyVerifier extends AbstractJGitHostKeyVerifier {
         /***
          * let's make spotbugs happy....
          */
+        @Serial
         private static final long serialVersionUID = 1L;
 
         public NoHostJGitKeyVerifier(TaskListener listener, HostKeyVerifierFactory hostKeyVerifierFactory) {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package hudson.plugins.git;`
`2`	`2`
	`3`	`+import java.io.Serial;`
`3`	`4`	`import java.io.Serializable;`
`4`	`5`	`import java.util.Objects;`
`5`	`6`	`import org.eclipse.jgit.submodule.SubmoduleWalk;`
`@@ -155,5 +156,6 @@ public IndexEntry(SubmoduleWalk walk) {`
`155`	`156`	`this("160000", "commit", walk.getObjectId().name(), walk.getPath());`
`156`	`157`	`}`
`157`	`158`
	`159`	`+ @Serial`
`158`	`160`	`private static final long serialVersionUID = 1L;`
`159`	`161`	`}`