Merge pull request #79 from JavaBWAPI/publicidenum

JasperGeurtz · web-flow · commit 291dff2a7836 · 2022-10-14T18:03:44.000+02:00
Add `public` final id for all enums
diff --git a/src/main/java/bwapi/CoordinateType.java b/src/main/java/bwapi/CoordinateType.java
@@ -29,7 +29,7 @@ public enum CoordinateType {
         Arrays.stream(CoordinateType.values()).forEach(v -> idToEnum[v.id] = v);
     }
 
-    final int id;
+    public final int id;
 
     CoordinateType(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/DamageType.java b/src/main/java/bwapi/DamageType.java
@@ -24,7 +24,7 @@ public enum DamageType {
     None(5),
     Unknown(6);
 
-    final int id;
+    public final int id;
 
     DamageType(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/ExplosionType.java b/src/main/java/bwapi/ExplosionType.java
@@ -32,7 +32,7 @@ public enum ExplosionType {
     Air_Splash(23),
     Unknown(24);
 
-    final int id;
+    public final int id;
 
     ExplosionType(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/Flag.java b/src/main/java/bwapi/Flag.java
@@ -16,7 +16,7 @@ public enum Flag {
      */
     UserInput(1);
 
-    final int id;
+    public final int id;
 
     Flag(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/Key.java b/src/main/java/bwapi/Key.java
@@ -235,7 +235,7 @@ public enum Key {
     K_PA1(253),
     K_OEM_CLEAR(254);
 
-    final int id;
+    public final int id;
 
     Key(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/MouseButton.java b/src/main/java/bwapi/MouseButton.java
@@ -11,7 +11,7 @@ public enum MouseButton {
     M_MIDDLE(2),
     M_MAX(3);
 
-    final int id;
+    public final int id;
 
     MouseButton(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/Text.java b/src/main/java/bwapi/Text.java
@@ -115,10 +115,10 @@ public enum Text {
      */
     Turquoise(31);
 
-    final byte id;
+    public final int id;
 
     Text(final int id) {
-        this.id = (byte) id;
+        this.id = id;
     }
 
     /**
@@ -160,7 +160,7 @@ public enum Size {
          */
         Huge(3);
 
-        final int id;
+        public final int id;
 
         Size(final int id) {
             this.id = id;
diff --git a/src/main/java/bwapi/UnitCommandType.java b/src/main/java/bwapi/UnitCommandType.java
@@ -53,7 +53,7 @@ public enum UnitCommandType {
     None(44),
     Unknown(45);
 
-    final int id;
+    public final int id;
 
     UnitCommandType(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/UnitSizeType.java b/src/main/java/bwapi/UnitSizeType.java
@@ -21,7 +21,7 @@ public enum UnitSizeType {
     None(4),
     Unknown(5);
 
-    final int id;
+    public final int id;
 
     UnitSizeType(final int id) {
         this.id = id;
diff --git a/src/main/java/bwapi/WeaponType.java b/src/main/java/bwapi/WeaponType.java
@@ -404,7 +404,7 @@ public enum WeaponType {
             TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None, TechType.None
     };
 
-    final int id;
+    public final int id;
 
     WeaponType(final int id) {
         this.id = id;
diff --git a/src/test/java/bwapi/EnumsTest.java b/src/test/java/bwapi/EnumsTest.java
@@ -6,11 +6,12 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
-import java.util.ArrayList;
+import java.lang.reflect.Modifier;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
@@ -22,17 +23,19 @@ public class EnumsTest {
     static String ID_VALUE = "id";
 
 
-    static List<Class<?>> getBWAPIEnums() throws ClassNotFoundException {
-        List<Class<?>> enums = new ArrayList<>();
-        for (File file : Objects.requireNonNull(new File(CLASSES_LOCATION).listFiles())) {
-            if (file.isFile()) {
-                Class<?> cls = Class.forName("bwapi." + file.getName().replace(".java", ""));
-                if (cls.isEnum()) {
-                    enums.add(cls);
-                }
-            }
-        }
-        return enums;
+    static List<Class<?>> getBWAPIEnums() {
+        return Arrays.stream(Objects.requireNonNull(new File(CLASSES_LOCATION).listFiles()))
+                .filter(File::isFile)
+                .map(f -> {
+                    try {
+                        return Class.forName("bwapi." + f.getName().replace(".java", ""));
+                    } catch (final ClassNotFoundException exc) {
+                        throw new RuntimeException(exc);
+                    }
+                })
+                .filter(Class::isEnum)
+                .flatMap(e -> Stream.concat(Stream.of(e), Arrays.stream(e.getDeclaredClasses()).filter(Class::isEnum)))
+                .collect(Collectors.toList());
     }
     /*
      * Check, via reflection, that all Enums that have an "idToEnum" array to be of correct lenght
@@ -62,7 +65,7 @@ public void checkAllidToEnumsArrayLenghts() throws Exception {
     }
 
     @Test
-    public void ensureSimpleGettersReturnNonNullAndDontFail() throws ClassNotFoundException, InvocationTargetException, IllegalAccessException {
+    public void ensureSimpleGettersReturnNonNullAndDontFail() throws InvocationTargetException, IllegalAccessException {
         for (Class<?> cls : getBWAPIEnums()) {
             List<Method> simpleGetters = Arrays.stream(cls.getMethods())
                     .filter(it -> it.getParameterCount() == 0 && it.getReturnType() != Void.TYPE)
@@ -71,11 +74,20 @@ public void ensureSimpleGettersReturnNonNullAndDontFail() throws ClassNotFoundEx
                 for (Method getter : simpleGetters) {
                     // WHEN
                     Object result = getter.invoke(type);
-
                     // THEN
                     assertThat(result).describedAs("When calling " + getter.getName()).isNotNull();
                 }
             }
         }
     }
+
+    @Test
+    public void ensureEnumsExposePublicId() throws NoSuchFieldException {
+        for (Class<?> cls : getBWAPIEnums()) {
+            Field idField = cls.getField(ID_VALUE);
+            assertThat(Modifier.isPublic(idField.getModifiers()))
+                    .describedAs("ID public for class "+ cls)
+                    .isTrue();
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public enum CoordinateType {`
`29`	`29`	`Arrays.stream(CoordinateType.values()).forEach(v -> idToEnum[v.id] = v);`
`30`	`30`	`}`
`31`	`31`
`32`		`- final int id;`
	`32`	`+ public final int id;`
`33`	`33`
`34`	`34`	`CoordinateType(final int id) {`
`35`	`35`	`this.id = id;`