Merge pull request #651 from csmith/master

Assign IDs to windows.

src/com/dmdirc/FrameContainer.java

@@ -82,6 +82,8 @@ public class FrameContainer implements WindowModel {
     private Optional<InputModel> inputModel = Optional.empty();
     /** The connection associated with this model. */
     private Optional<Connection> connection = Optional.empty();
+    /** The ID for this window. */
+    @Nullable private String id = null;
 
     /**
      * Instantiate new frame container.
@@ -115,6 +117,22 @@ public class FrameContainer implements WindowModel {
         backBuffer.startAddingEvents();
     }
 
+    @Override
+    public String getId() {
+        if (this.id == null) {
+            throw new IllegalStateException("ID has not been set");
+        }
+        return id;
+    }
+
+    @Override
+    public void setId(@Nullable final String id) {
+        if (this.id != null) {
+            throw new IllegalStateException("ID already set");
+        }
+        this.id = id;
+    }
+
     @Override
     public String getIcon() {
         return icon;

src/com/dmdirc/interfaces/WindowModel.java

@@ -38,6 +38,21 @@ import java.util.Set;
  */
 public interface WindowModel {
 
+    /**
+     * Gets a unique ID that identifies this window.
+     *
+     * @return This window's unique ID.
+     */
+    String getId();
+
+    /**
+     * Sets the ID for this window. This may only be called once; attempting to overwrite a
+     * previous ID will throw an exception.
+     *
+     * @param id The new ID for this window.
+     */
+    void setId(String id);
+
     String getIcon();
 
     String getName();

src/com/dmdirc/ui/WindowManager.java

@@ -39,6 +39,7 @@ import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.concurrent.atomic.AtomicLong;
 
 import javax.inject.Inject;
 import javax.inject.Singleton;
@@ -60,8 +61,12 @@ public class WindowManager {
     private final Map<WindowModel, WindowModel> parents = new HashMap<>();
     /** Mapping of parents to their children. */
     private final Multimap<WindowModel, WindowModel> children = ArrayListMultimap.create();
+    /** Mapping of IDs to windows. */
+    private final Map<String, WindowModel> windowsById = new HashMap<>();
     /** A list of frame listeners. */
     private final ListenerList listeners = new ListenerList();
+    /** Counter to use for ID assignments. */
+    private final AtomicLong nextId = new AtomicLong(0L);
 
     /**
      * Creates a new instance of {@link WindowManager}.
@@ -182,7 +187,7 @@ public class WindowManager {
         checkArgument(!rootWindows.contains(window));
 
         rootWindows.add(window);
-
+        assignId(window);
         fireAddWindow(window, focus);
     }
 
@@ -220,7 +225,7 @@ public class WindowManager {
 
         parents.put(child, parent);
         children.put(parent, child);
-
+        assignId(child);
         fireAddWindow(parent, child, focus);
     }
 
@@ -256,6 +261,7 @@ public class WindowManager {
 
         children.get(window).forEach(WindowModel::close);
         children.removeAll(window);
+        windowsById.remove(window.getId());
 
         if (rootWindows.contains(window)) {
             fireDeleteWindow(window);
@@ -332,6 +338,27 @@ public class WindowManager {
         return Collections.unmodifiableCollection(rootWindows);
     }
 
+    /**
+     * Retrieves the window with the specified ID.
+     *
+     * @param id The ID of the window to retrieve
+     * @return The window with the given ID, if it exists.
+     */
+    public Optional<WindowModel> getWindowById(final String id) {
+        return Optional.ofNullable(windowsById.get(id));
+    }
+
+    /**
+     * Assigns a unique ID to the given window.
+     *
+     * @param window The window to assign an ID to.
+     */
+    private void assignId(final WindowModel window) {
+        final String id = "WINDOW/" + nextId.getAndIncrement();
+        window.setId(id);
+        windowsById.put(id, window);
+    }
+
     /**
      * Fires the addWindow(Window) callback.
      *

test/com/dmdirc/ui/WindowManagerTest.java

@@ -33,11 +33,15 @@ import java.util.Optional;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertSame;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.Matchers.anyBoolean;
 import static org.mockito.Matchers.anyObject;
@@ -56,6 +60,7 @@ public class WindowManagerTest {
     @Mock private WindowModel child;
     @Mock private WindowModel grandchild;
     @Mock private DMDircMBassador eventBus;
+    @Captor private ArgumentCaptor<String> idCaptor;
     private WindowManager manager;
 
     @Before
@@ -269,4 +274,35 @@ public class WindowManagerTest {
 
         assertNull(manager.findCustomWindow(customContainer, "test"));
     }
+
+    @Test
+    public void testAssignId() {
+        manager.addWindow(container);
+        manager.addWindow(container, child);
+
+        verify(container).setId(idCaptor.capture());
+        final String parentId = idCaptor.getValue();
+
+        verify(child).setId(idCaptor.capture());
+        final String childId = idCaptor.getValue();
+
+        assertNotEquals(parentId, childId);
+    }
+
+    @Test
+    public void testGetById() {
+        manager.addWindow(container);
+        manager.addWindow(container, child);
+
+        verify(container).setId(idCaptor.capture());
+        final String parentId = idCaptor.getValue();
+
+        verify(child).setId(idCaptor.capture());
+        final String childId = idCaptor.getValue();
+
+        assertSame(container, manager.getWindowById(parentId).get());
+        assertSame(child, manager.getWindowById(childId).get());
+        assertEquals(Optional.empty(), manager.getWindowById("invalid"));
+    }
+
 }