Refactor

eleanorgoh · eleanorgoh · commit e685367f0877 · 2024-04-25T11:07:16.000-07:00
diff --git a/src/main/java/org/kohsuke/github/GHEventPayload.java b/src/main/java/org/kohsuke/github/GHEventPayload.java
@@ -1458,55 +1458,14 @@ public static class Repository extends GHEventPayload {
     public static class RepositoryChanges extends GHEventPayload {
         private GHRepositoryChanges changes;
 
+        /**
+         * Get changes.
+         *
+         * @return GHRepositoryChanges
+         */
         public GHRepositoryChanges getChanges() {
             return changes;
         }
-
-        public static class GHRepositoryChanges {
-            private FromRepository repository;
-            private Owner owner;
-
-            public Owner getOwner() {
-                return owner;
-            }
-
-            public static class Owner {
-                private FromOwner from;
-
-                public FromOwner getFrom() {
-                    return from;
-                }
-            }
-
-            public static class FromOwner {
-                private GHUser user;
-
-                @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
-                public GHUser getUser() {
-                    return user;
-                }
-            }
-
-            public FromRepository getRepository() {
-                return repository;
-            }
-
-            public static class FromRepository {
-                private FromName name;
-
-                public FromName getName() {
-                    return name;
-                }
-            }
-
-            public static class FromName {
-                private String from;
-
-                public String getFrom() {
-                    return from;
-                }
-            }
-        }
     }
 
     /**
diff --git a/src/main/java/org/kohsuke/github/GHRepositoryChanges.java b/src/main/java/org/kohsuke/github/GHRepositoryChanges.java
@@ -0,0 +1,95 @@
+package org.kohsuke.github;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+/**
+ * Changes made to a repository.
+ */
+@SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD" }, justification = "JSON API")
+public class GHRepositoryChanges {
+    private FromRepository repository;
+    private Owner owner;
+
+    /**
+     * Get outer owner object.
+     *
+     * @return Owner
+     */
+    public Owner getOwner() {
+        return owner;
+    }
+
+    /**
+     * Outer object of owner from whom this repository was transferred.
+     */
+    public static class Owner {
+        private FromOwner from;
+
+        /**
+         * Get in owner object.
+         *
+         * @return FromOwner
+         */
+        public FromOwner getFrom() {
+            return from;
+        }
+    }
+
+    /**
+     * Owner from whom this repository was transferred.
+     */
+    public static class FromOwner {
+        private GHUser user;
+
+        /**
+         * Get user from which this repository was transferrred.
+         *
+         * @return user
+         */
+        @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")
+        public GHUser getUser() {
+            return user;
+        }
+    }
+
+    /**
+     * Get repository.
+     *
+     * @return FromRepository
+     */
+    public FromRepository getRepository() {
+        return repository;
+    }
+
+    /**
+     * Repository object from which the name was changed.
+     */
+    public static class FromRepository {
+        private FromName name;
+
+        /**
+         * Get top level object for the previous name of the repository.
+         *
+         * @return FromName
+         */
+        public FromName getName() {
+            return name;
+        }
+    }
+
+    /**
+     * Repository name that was changed.
+     */
+    public static class FromName {
+        private String from;
+
+        /**
+         * Get previous name of the repository before rename.
+         *
+         * @return String
+         */
+        public String getFrom() {
+            return from;
+        }
+    }
+}
diff --git a/src/test/java/org/kohsuke/github/GHEventPayloadTest.java b/src/test/java/org/kohsuke/github/GHEventPayloadTest.java
@@ -772,6 +772,12 @@ public void repository() throws Exception {
         assertThat(event.getSender().getLogin(), is("baxterthehacker"));
     }
 
+    /**
+     * Repository renamed.
+     *
+     * @throws Exception
+     *             the exception
+     */
     @Test
     public void repository_renamed() throws Exception {
         final GHEventPayload.RepositoryChanges event = GitHub.offline()
@@ -784,6 +790,12 @@ public void repository_renamed() throws Exception {
         assertThat(event.getSender().getLogin(), is("egoh"));
     }
 
+    /**
+     * Repository ownership transferred.
+     *
+     * @throws Exception
+     *             the exception
+     */
     @Test
     public void repository_transferred() throws Exception {
         final GHEventPayload.RepositoryChanges event = GitHub.offline()
