FrameContainer parents are Optional.

Change-Id: Ibaf13d210cd01e73adf08bac359244b14faef088
Depends-On: Ief9fccad45d654ffaee9d7a124ebc39f7af56166
Reviewed-on: http://gerrit.dmdirc.com/3470
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/CustomWindow.java

@@ -27,6 +27,7 @@ import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.ui.core.components.WindowComponent;
 import com.dmdirc.util.URLBuilder;
 
+import com.google.common.base.Optional;
 import com.google.common.eventbus.EventBus;
 
 import java.util.Arrays;
@@ -76,7 +77,8 @@ public class CustomWindow extends FrameContainer {
 
     @Override
     public Connection getConnection() {
-        return getParent() == null ? null : getParent().getConnection();
+        final Optional<FrameContainer> parent = getParent();
+        return parent.isPresent() ? parent.get().getConnection() : null;
     }
 
 }

src/com/dmdirc/FrameContainer.java

@@ -74,7 +74,7 @@ public abstract class FrameContainer {
     /** The children of this frame. */
     private final Collection<FrameContainer> children = new CopyOnWriteArrayList<>();
     /** The parent of this frame. */
-    private final FrameContainer parent;
+    private final Optional<FrameContainer> parent;
     /** The name of the icon being used for this container's frame. */
     private String icon;
     /** The name of this container. */
@@ -141,7 +141,7 @@ public abstract class FrameContainer {
             final URLBuilder urlBuilder,
             final EventBus eventBus,
             final Collection<String> components) {
-        this.parent = parent;
+        this.parent = Optional.fromNullable(parent);
         this.configManager = config;
         this.name = name;
         this.title = title;
@@ -185,7 +185,7 @@ public abstract class FrameContainer {
             final MessageSinkManager messageSinkManager,
             final EventBus eventbus,
             final Collection<String> components) {
-        this.parent = parent;
+        this.parent = Optional.fromNullable(parent);
         this.configManager = config;
         this.name = name;
         this.title = title;
@@ -205,7 +205,7 @@ public abstract class FrameContainer {
         return notification;
     }
 
-    public FrameContainer getParent() {
+    public Optional<FrameContainer> getParent() {
         return parent;
     }
 

src/com/dmdirc/commandparser/commands/global/Echo.java

@@ -39,6 +39,8 @@ import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.ui.WindowManager;
 import com.dmdirc.ui.input.AdditionalTabTargets;
 
+import com.google.common.base.Optional;
+
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
@@ -99,12 +101,12 @@ public class Echo extends Command implements IntelligentCommand {
 
         if (results.hasFlag(targetFlag)) {
             FrameContainer frame = null;
-            FrameContainer target = origin;
+            Optional<FrameContainer> target = Optional.of(origin);
 
-            while (frame == null && target != null) {
-                frame = windowManager.findCustomWindow(target,
+            while (frame == null && target.isPresent()) {
+                frame = windowManager.findCustomWindow(target.get(),
                         results.getArgumentsAsString(targetFlag));
-                target = target.getParent();
+                target = target.get().getParent();
             }
 
             if (frame == null) {

src/com/dmdirc/commandparser/commands/server/JoinChannelCommand.java

@@ -40,6 +40,7 @@ import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.messages.Styliser;
 import com.dmdirc.util.collections.MapList;
 
+import com.google.common.base.Optional;
 import com.google.common.eventbus.EventBus;
 import com.google.common.eventbus.Subscribe;
 
@@ -173,8 +174,9 @@ public class JoinChannelCommand extends Command implements IntelligentCommand {
         }
 
         // Check the parent window
-        if (checkParents && source.getParent() != null) {
-            results.addAll(checkSource(source.getParent(), true, false));
+        final Optional<FrameContainer> parent = source.getParent();
+        if (checkParents && parent.isPresent()) {
+            results.addAll(checkSource(parent.get(), true, false));
         }
 
         // Check the children window

src/com/dmdirc/ui/WindowManager.java

@@ -29,6 +29,8 @@ import com.dmdirc.interfaces.FrameCloseListener;
 import com.dmdirc.interfaces.ui.FrameListener;
 import com.dmdirc.util.collections.ListenerList;
 
+import com.google.common.base.Optional;
+
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
@@ -39,6 +41,7 @@ import javax.inject.Singleton;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
+import static com.google.common.base.Preconditions.checkState;
 
 /**
  * The WindowManager maintains a list of all open windows, and their parent/child relations.
@@ -208,8 +211,12 @@ public class WindowManager {
      * @return True if the target is in the hierarchy, false otherise
      */
     protected boolean isInHierarchy(final FrameContainer target) {
-        return target != null && (rootWindows.contains(target)
-                || isInHierarchy(target.getParent()));
+        if (rootWindows.contains(target)) {
+            return true;
+        }
+
+        final Optional<FrameContainer> parent = target.getParent();
+        return parent.isPresent() && isInHierarchy(parent.get());
     }
 
     /**
@@ -237,9 +244,10 @@ public class WindowManager {
             fireDeleteWindow(window);
             rootWindows.remove(window);
         } else {
-            final FrameContainer parent = window.getParent();
-            fireDeleteWindow(parent, window);
-            parent.removeChild(window);
+            final Optional<FrameContainer> parent = window.getParent();
+            checkState(parent.isPresent());
+            fireDeleteWindow(parent.get(), window);
+            parent.get().removeChild(window);
         }
     }
 

test/com/dmdirc/ui/WindowManagerTest.java

@@ -25,6 +25,8 @@ import com.dmdirc.CustomWindow;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.interfaces.ui.FrameListener;
 
+import com.google.common.base.Optional;
+
 import java.util.Arrays;
 import java.util.Collection;
 
@@ -34,8 +36,17 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.junit.Assert.*;
-import static org.mockito.Mockito.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.anyBoolean;
+import static org.mockito.Matchers.anyObject;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Matchers.same;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 @RunWith(MockitoJUnitRunner.class)
 public class WindowManagerTest {
@@ -90,7 +101,7 @@ public class WindowManagerTest {
         manager.addWindow(container, child);
         manager.addListener(frameListener);
 
-        when(child.getParent()).thenReturn(container);
+        when(child.getParent()).thenReturn(Optional.of(container));
 
         manager.removeWindow(child);
 
@@ -148,7 +159,7 @@ public class WindowManagerTest {
     public void testRemoveWindowRootWindowWithChildren() {
         when(container.getChildren()).thenReturn(Arrays.asList(
                 new FrameContainer[]{child, }));
-        when(child.getParent()).thenReturn(container);
+        when(child.getParent()).thenReturn(Optional.of(container));
 
         manager.addListener(frameListener);
         manager.addWindow(container);
@@ -162,7 +173,7 @@ public class WindowManagerTest {
     public void testRemoveChildWindowNoChildren() {
         when(container.getChildren()).thenReturn(Arrays.asList(
                 new FrameContainer[]{child, }));
-        when(child.getParent()).thenReturn(container);
+        when(child.getParent()).thenReturn(Optional.of(container));
 
         manager.addListener(frameListener);
         manager.addWindow(container);
@@ -178,7 +189,7 @@ public class WindowManagerTest {
                 new FrameContainer[]{child, }));
         when(child.getChildren()).thenReturn(Arrays.asList(
                 new FrameContainer[]{grandchild, }));
-        when(child.getParent()).thenReturn(container);
+        when(child.getParent()).thenReturn(Optional.of(container));
 
         manager.addListener(frameListener);
         manager.addWindow(container);
@@ -195,7 +206,7 @@ public class WindowManagerTest {
         final FrameContainer root2 = mock(FrameContainer.class);
         final Collection<FrameContainer> rootWindows
                 = Arrays.asList(new FrameContainer[]{root1, root2, });
-        
+
         manager.addWindow(root1);
         manager.addWindow(root2);