[ntcore] Change Java event mask to EnumSet (#4564)

Also convert NetworkTableInstance.getNetworkMode() to return EnumSet.

ntcore/src/generate/java/NetworkTableInstance.java.jinja

@@ -7,6 +7,7 @@ package edu.wpi.first.networktables;
 import edu.wpi.first.util.WPIUtilJNI;
 import edu.wpi.first.util.concurrent.Event;
 import edu.wpi.first.util.datalog.DataLog;
+import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
@@ -35,16 +36,33 @@ import java.util.function.Consumer;
  */
 @SuppressWarnings("PMD.CouplingBetweenObjects")
 public final class NetworkTableInstance implements AutoCloseable {
-  /**
-   * Client/server mode flag values (as returned by {@link #getNetworkMode()}). This is a bitmask.
-   */
-  public static final int kNetModeNone = 0x00;
+  /** Client/server mode flag values (as returned by {@link #getNetworkMode()}). */
+  public enum NetworkMode {
+    /** Running in server mode. */
+    kServer(0x01),
 
-  public static final int kNetModeServer = 0x01;
-  public static final int kNetModeClient3 = 0x02;
-  public static final int kNetModeClient4 = 0x04;
-  public static final int kNetModeStarting = 0x08;
-  public static final int kNetModeLocal = 0x10;
+    /** Running in NT3 client mode. */
+    kClient3(0x02),
+
+    /** Running in NT4 client mode. */
+    kClient4(0x04),
+
+    /** Currently starting up (either client or server). */
+    kStarting(0x08),
+
+    /** Running in local-only mode. */
+    kLocal(0x10);
+
+    private final int value;
+
+    NetworkMode(int value) {
+      this.value = value;
+    }
+
+    public int getValue() {
+      return value;
+    }
+  }
 
   /** The default port that network tables operates on for NT3. */
   public static final int kDefaultPort3 = 1735;
@@ -370,14 +388,17 @@ public final class NetworkTableInstance implements AutoCloseable {
       m_inst = inst;
     }
 
-    int add(String[] prefixes, int mask, Consumer<NetworkTableEvent> listener) {
+    int add(
+        String[] prefixes,
+        EnumSet<NetworkTableEvent.Kind> eventKinds,
+        Consumer<NetworkTableEvent> listener) {
       m_lock.lock();
       try {
         if (m_poller == 0) {
           m_poller = NetworkTablesJNI.createListenerPoller(m_inst.getHandle());
           startThread();
         }
-        int h = NetworkTablesJNI.addListener(m_poller, prefixes, mask);
+        int h = NetworkTablesJNI.addListener(m_poller, prefixes, eventKinds);
         m_listeners.put(h, listener);
         return h;
       } finally {
@@ -385,14 +406,17 @@ public final class NetworkTableInstance implements AutoCloseable {
       }
     }
 
-    int add(int handle, int mask, Consumer<NetworkTableEvent> listener) {
+    int add(
+        int handle,
+        EnumSet<NetworkTableEvent.Kind> eventKinds,
+        Consumer<NetworkTableEvent> listener) {
       m_lock.lock();
       try {
         if (m_poller == 0) {
           m_poller = NetworkTablesJNI.createListenerPoller(m_inst.getHandle());
           startThread();
         }
-        int h = NetworkTablesJNI.addListener(m_poller, handle, mask);
+        int h = NetworkTablesJNI.addListener(m_poller, handle, eventKinds);
         m_listeners.put(h, listener);
         return h;
       } finally {
@@ -563,9 +587,11 @@ public final class NetworkTableInstance implements AutoCloseable {
    */
   public int addConnectionListener(
       boolean immediateNotify, Consumer<NetworkTableEvent> listener) {
-    return m_listeners.add(m_handle,
-        NetworkTableEvent.kConnection | (immediateNotify ? NetworkTableEvent.kImmediate : 0),
-        listener);
+    EnumSet<NetworkTableEvent.Kind> eventKinds = EnumSet.of(NetworkTableEvent.Kind.kConnection);
+    if (immediateNotify) {
+      eventKinds.add(NetworkTableEvent.Kind.kImmediate);
+    }
+    return m_listeners.add(m_handle, eventKinds, listener);
   }
 
   /**
@@ -577,16 +603,18 @@ public final class NetworkTableInstance implements AutoCloseable {
    * listener.
    *
    * @param topic Topic
-   * @param eventMask Bitmask of TopicListenerFlags values
+   * @param eventKinds set of event kinds to listen to
    * @param listener Listener function
    * @return Listener handle
    */
   public int addListener(
-      Topic topic, int eventMask, Consumer<NetworkTableEvent> listener) {
+      Topic topic,
+      EnumSet<NetworkTableEvent.Kind> eventKinds,
+      Consumer<NetworkTableEvent> listener) {
     if (topic.getInstance().getHandle() != m_handle) {
       throw new IllegalArgumentException("topic is not from this instance");
     }
-    return m_listeners.add(topic.getHandle(), eventMask, listener);
+    return m_listeners.add(topic.getHandle(), eventKinds, listener);
   }
 
   /**
@@ -596,16 +624,18 @@ public final class NetworkTableInstance implements AutoCloseable {
    * active.
    *
    * @param subscriber Subscriber
-   * @param eventMask Bitmask of TopicListenerFlags values
+   * @param eventKinds set of event kinds to listen to
    * @param listener Listener function
    * @return Listener handle
    */
   public int addListener(
-      Subscriber subscriber, int eventMask, Consumer<NetworkTableEvent> listener) {
+      Subscriber subscriber,
+      EnumSet<NetworkTableEvent.Kind> eventKinds,
+      Consumer<NetworkTableEvent> listener) {
     if (subscriber.getTopic().getInstance().getHandle() != m_handle) {
       throw new IllegalArgumentException("subscriber is not from this instance");
     }
-    return m_listeners.add(subscriber.getHandle(), eventMask, listener);
+    return m_listeners.add(subscriber.getHandle(), eventKinds, listener);
   }
 
   /**
@@ -615,16 +645,18 @@ public final class NetworkTableInstance implements AutoCloseable {
    * active.
    *
    * @param subscriber Subscriber
-   * @param eventMask Bitmask of TopicListenerFlags values
+   * @param eventKinds set of event kinds to listen to
    * @param listener Listener function
    * @return Listener handle
    */
   public int addListener(
-      MultiSubscriber subscriber, int eventMask, Consumer<NetworkTableEvent> listener) {
+      MultiSubscriber subscriber,
+      EnumSet<NetworkTableEvent.Kind> eventKinds,
+      Consumer<NetworkTableEvent> listener) {
     if (subscriber.getInstance().getHandle() != m_handle) {
       throw new IllegalArgumentException("subscriber is not from this instance");
     }
-    return m_listeners.add(subscriber.getHandle(), eventMask, listener);
+    return m_listeners.add(subscriber.getHandle(), eventKinds, listener);
   }
 
   /**
@@ -633,16 +665,18 @@ public final class NetworkTableInstance implements AutoCloseable {
    * accessing any shared state from the callback function.
    *
    * @param entry Entry
-   * @param eventMask Bitmask of TopicListenerFlags values
+   * @param eventKinds set of event kinds to listen to
    * @param listener Listener function
    * @return Listener handle
    */
   public int addListener(
-      NetworkTableEntry entry, int eventMask, Consumer<NetworkTableEvent> listener) {
+      NetworkTableEntry entry,
+      EnumSet<NetworkTableEvent.Kind> eventKinds,
+      Consumer<NetworkTableEvent> listener) {
     if (entry.getTopic().getInstance().getHandle() != m_handle) {
       throw new IllegalArgumentException("entry is not from this instance");
     }
-    return m_listeners.add(entry.getHandle(), eventMask, listener);
+    return m_listeners.add(entry.getHandle(), eventKinds, listener);
   }
 
   /**
@@ -655,15 +689,15 @@ public final class NetworkTableInstance implements AutoCloseable {
    * listener.
    *
    * @param prefixes Topic name string prefixes
-   * @param eventMask Bitmask of TopicListenerFlags values
+   * @param eventKinds set of event kinds to listen to
    * @param listener Listener function
    * @return Listener handle
    */
   public int addListener(
       String[] prefixes,
-      int eventMask,
+      EnumSet<NetworkTableEvent.Kind> eventKinds,
       Consumer<NetworkTableEvent> listener) {
-    return m_listeners.add(prefixes, eventMask, listener);
+    return m_listeners.add(prefixes, eventKinds, listener);
   }
 
   /*
@@ -673,10 +707,17 @@ public final class NetworkTableInstance implements AutoCloseable {
   /**
    * Get the current network mode.
    *
-   * @return Bitmask of NetworkMode.
+   * @return Enum set of NetworkMode.
    */
-  public int getNetworkMode() {
-    return NetworkTablesJNI.getNetworkMode(m_handle);
+  public EnumSet<NetworkMode> getNetworkMode() {
+    int flags = NetworkTablesJNI.getNetworkMode(m_handle);
+    EnumSet<NetworkMode> rv = EnumSet.noneOf(NetworkMode.class);
+    for (NetworkMode mode : NetworkMode.values()) {
+      if ((flags & mode.getValue()) != 0) {
+        rv.add(mode);
+      }
+    }
+    return rv;
   }
 
   /**

ntcore/src/generate/java/NetworkTablesJNI.java.jinja

@@ -7,6 +7,7 @@ package edu.wpi.first.networktables;
 import edu.wpi.first.util.RuntimeLoader;
 import edu.wpi.first.util.datalog.DataLog;
 import java.io.IOException;
+import java.util.EnumSet;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 public final class NetworkTablesJNI {
@@ -203,6 +204,22 @@ public final class NetworkTablesJNI {
 
   public static native void destroyListenerPoller(int poller);
 
+  private static int kindsToMask(EnumSet<NetworkTableEvent.Kind> kinds) {
+    int mask = 0;
+    for (NetworkTableEvent.Kind kind : kinds) {
+      mask |= kind.getValue();
+    }
+    return mask;
+  }
+
+  public static int addListener(int poller, String[] prefixes, EnumSet<NetworkTableEvent.Kind> kinds) {
+    return addListener(poller, prefixes, kindsToMask(kinds));
+  }
+
+  public static int addListener(int poller, int handle, EnumSet<NetworkTableEvent.Kind> kinds) {
+    return addListener(poller, handle, kindsToMask(kinds));
+  }
+
   public static native int addListener(int poller, String[] prefixes, int mask);
 
   public static native int addListener(int poller, int handle, int mask);