Merge pull request #285 from AustinShalit/AustinShalit-SourcesSocketHandles

Sources Socket Handles

Author: JLLeitschuh

core/src/main/java/edu/wpi/grip/core/Connection.java

@@ -48,6 +48,8 @@ public InputSocket<T> getInputSocket() {
     @Subscribe
     public void onConnectionAdded(ConnectionAddedEvent event) {
         if (event.getConnection().equals(this)) {
+            inputSocket.addConnection(this);
+            outputSocket.addConnection(this);
             inputSocket.setValueOptional(outputSocket.getValue());
         }
     }
@@ -59,6 +61,14 @@ public void onOutputChanged(SocketChangedEvent e) {
         }
     }
 
+    @Subscribe
+    public void onConnectionRemoved(ConnectionRemovedEvent e) {
+        if (e.getConnection() == this) {
+            inputSocket.removeConnection(this);
+            outputSocket.removeConnection(this);
+        }
+    }
+
     @Subscribe
     public void removeConnection(StepRemovedEvent e) {
         // Remove this connection if one of the steps it was connected to was removed

core/src/main/java/edu/wpi/grip/core/InputSocket.java

@@ -23,13 +23,12 @@ public InputSocket(EventBus eventBus, SocketHint<T> socketHint) {
     }
 
     /**
-     * Reset the socket to its default value when it's no longer connected to anything.  This prevents removed
-     * connections from continuing to have an effect on steps because they still hold references to the values they
-     * were connected to.
+     * {@inheritDoc}
      */
-    @Subscribe
-    public void onDisconnected(SocketConnectedChangedEvent event) {
-        if (event.getSocket() == this && this.getConnections().isEmpty()) {
+    @Override
+    protected void onDisconnected() {
+        super.onDisconnected();
+        if (this.getConnections().isEmpty()) {
             this.setValue(this.getSocketHint().createInitialValue().orElse(null));
         }
     }

core/src/main/java/edu/wpi/grip/core/Socket.java

@@ -13,8 +13,8 @@
 import java.util.Optional;
 import java.util.Set;
 
-import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
+import static com.google.common.base.Preconditions.checkNotNull;
 
 /**
  * A Socket is an abstract wrapper for a value that can be updated and passed around operations.  Sockets contain a set of hints
@@ -134,29 +134,38 @@ public Set<Connection> getConnections() {
         return ImmutableSet.copyOf(this.connections);
     }
 
+    /**
+     * @param connection The connection to add to this socket.
+     */
+    public void addConnection(Connection connection) {
+        checkNotNull(connection, "Can not remove null connection");
+        this.connections.add(connection);
 
-    @Subscribe
-    public void onConnectionAdded(ConnectionAddedEvent event) {
-        if (event.getConnection().getInputSocket() == this || event.getConnection().getOutputSocket() == this) {
-            this.connections.add(event.getConnection());
-
-            if (this.connections.size() == 1) {
-                this.eventBus.post(new SocketConnectedChangedEvent(this));
-            }
+        if (this.connections.size() == 1) {
+            this.eventBus.post(new SocketConnectedChangedEvent(this));
         }
     }
 
-    @Subscribe
-    public void onConnectionRemoved(ConnectionRemovedEvent event) {
-        if (event.getConnection().getInputSocket() == this || event.getConnection().getOutputSocket() == this) {
-            this.connections.remove(event.getConnection());
+    /**
+     * @param connection The connection to remove from this socket.
+     */
+    public void removeConnection(Connection connection) {
+        checkNotNull(connection, "Can not remove null connection");
+        onDisconnected();
+        this.connections.remove(connection);
 
-            if (this.connections.isEmpty()) {
-                this.eventBus.post(new SocketConnectedChangedEvent(this));
-            }
+        if (this.connections.isEmpty()) {
+            this.eventBus.post(new SocketConnectedChangedEvent(this));
         }
     }
 
+    /**
+     * Reset the socket to its default value when it's no longer connected to anything.  This prevents removed
+     * connections from continuing to have an effect on steps because they still hold references to the values they
+     * were connected to.
+     */
+    protected void onDisconnected() {}
+
     @Override
     public String toString() {
         return MoreObjects.toStringHelper(this)

core/src/main/java/edu/wpi/grip/core/Step.java

@@ -46,15 +46,7 @@ public Step create(Operation operation) {
             checkNotNull(operation, "The operation can not be null");
             // Create the list of input and output sockets, and mark this step as their owner.
             final InputSocket<?>[] inputSockets = operation.createInputSockets(eventBus);
-
-            for (Socket<?> socket : inputSockets) {
-                eventBus.register(socket);
-            }
-
             final OutputSocket<?>[] outputSockets = operation.createOutputSockets(eventBus);
-            for (Socket<?> socket : outputSockets) {
-                eventBus.register(socket);
-            }
 
             final Step step = new Step(
                     operation,

core/src/main/java/edu/wpi/grip/core/sources/ImageFileSource.java

@@ -94,7 +94,7 @@ public String getName() {
 
     @Override
     public OutputSocket[] createOutputSockets() {
-        return new OutputSocket[]{this.outputSocket};
+        return new OutputSocket[]{outputSocket};
     }
 
     @Override

core/src/main/java/edu/wpi/grip/core/sources/MultiImageFileSource.java

@@ -1,6 +1,5 @@
 package edu.wpi.grip.core.sources;
 
-
 import com.google.common.eventbus.EventBus;
 import com.google.common.math.IntMath;
 import com.google.inject.assistedinject.Assisted;
@@ -106,9 +105,7 @@ public String getName() {
 
     @Override
     protected OutputSocket[] createOutputSockets() {
-        return new OutputSocket[]{
-                outputSocket
-        };
+        return new OutputSocket[]{outputSocket};
     }
 
     @Override