Deprecate windowClosed and windowClosing methods.

These are a hold-over from when the core had to have a back-and-forth with
the UI in order to close a window.

Provide stub implementations in FrameContainer, deprecate them, and remove
any unecessary overrides in the core.

Change-Id: Icf9bfc6bc40b66135d161a5047d01d46b2171234
Reviewed-on: http://gerrit.dmdirc.com/3008
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/Channel.java

@@ -341,11 +341,6 @@ public class Channel extends MessageTarget implements ConfigChangeListener {
         server.delChannel(channelInfo.getName());
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public void windowClosed() {
-    }
-
     /**
      * Called every {general.whotime} seconds to check if the channel needs
      * to send a who request.

src/com/dmdirc/CustomWindow.java

@@ -59,21 +59,6 @@ public class CustomWindow extends FrameContainer {
                 Arrays.asList(WindowComponent.TEXTAREA.getIdentifier()));
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public void windowClosing() {
-        // 2: Remove any callbacks or listeners
-        // 3: Trigger any actions neccessary
-        // 4: Trigger action for the window closing
-        // 5: Inform any parents that the window is closing
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void windowClosed() {
-        // 7: Remove any references to the window and parents
-    }
-
     /** {@inheritDoc} */
     @Override
     public Connection getConnection() {

src/com/dmdirc/FrameContainer.java

@@ -402,7 +402,6 @@ public abstract class FrameContainer {
      * <p>
      * Frame containers must perform the following actions in this order:
      * <ol>
-     *  <li>Make the window non-visible (so it appears 'closed' to the user)</li>
      *  <li>Remove any callbacks or listeners (events should not be processed
      *      once a window has been requested to close)</li>
      *  <li>Trigger any actions necessary (terminating any TCP connections,
@@ -412,27 +411,13 @@ public abstract class FrameContainer {
      *  <li>Inform any parents that the window is closing (this includes
      *      unregistering the window with any specific managers, or from the
      *      parent windows if they track children)</li>
-     *  <li>Remove the window from the window manager (by calling
-     *      {@link WindowManager#removeWindow(com.dmdirc.FrameContainer)}</li>
      * </ol>
-     * <p>
-     * <strong>NB:</strong> As of DMDirc 0.6.5, points 1 and 6 (making windows
-     * non-visible and removing the window from the window manager) are handled
-     * by the caller of this method, and should <strong>not</strong> be
-     * implemented by subclasses.
-     * </p>
-     * <p>
-     * While resources may be relinquished in step three, references MUST NOT
-     * be removed yet. That is, if a window holds a resource, the resource may
-     * be closed, but the relevant object MUST still be available for
-     * interrogation at the end of this method.
-     * <p>
-     * This behaviour is required so that parties receiving windowDeleted events
-     * from the WindowManager may inspect the closing window and perform actions
-     * on its frame, parser, etc. The resources should be completely freed in
-     * the {@link #windowClosed()} method.
+     *
+     * @deprecated Clearing up should be performed in the {@link #close()} method.
      */
-    protected abstract void windowClosing();
+    @Deprecated
+    protected void windowClosing() {
+    }
 
     /**
      * Invoked when our window has been closed.
@@ -440,8 +425,12 @@ public abstract class FrameContainer {
      * At this point, all interested parties have been told that the window
      * has been closed, and therefore any references to frames or other
      * resources may be completely freed.
+     *
+     * @deprecated Clearing up should be performed in the {@link #close()} method.
      */
-    public abstract void windowClosed();
+    @Deprecated
+    public void windowClosed() {
+    }
 
     /**
      * Adds a line to this container's window. If the window is null for some

src/com/dmdirc/GlobalWindow.java

@@ -77,15 +77,6 @@ public class GlobalWindow extends WritableFrameContainer {
         return tabCompleter;
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public void windowClosing() {
-        // 2: Remove any callbacks or listeners
-        // 3: Trigger any actions neccessary
-        // 4: Trigger action for the window closing
-        // 5: Inform any parents that the window is closing
-    }
-
     /** {@inheritDoc} */
     @Override
     public void windowClosed() {

src/com/dmdirc/Query.java

@@ -63,7 +63,7 @@ public class Query extends MessageTarget implements PrivateActionListener,
         CompositionStateChangeListener {
 
     /** The Server this Query is on. */
-    private Server server;
+    private final Server server;
 
     /** The full host and nickname of the client associated with this Query. */
     private String host, nickname;
@@ -340,13 +340,6 @@ public class Query extends MessageTarget implements PrivateActionListener,
         }
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public void windowClosed() {
-        // 7: Remove any references to the window and parents
-        server = null;
-    }
-
     /**
      * Returns the host that this query is with.
      *

src/com/dmdirc/Raw.java

@@ -49,7 +49,7 @@ public class Raw extends WritableFrameContainer
         implements DataInListener, DataOutListener {
 
     /** The server object that's being monitored. */
-    private Server server;
+    private final Server server;
 
     /**
      * Creates a new instance of Raw.
@@ -101,13 +101,6 @@ public class Raw extends WritableFrameContainer
         server.delRaw();
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public void windowClosed() {
-        // 7: Remove any references to the window and parents
-        server = null;
-    }
-
     /** {@inheritDoc} */
     @Override
     public void onDataIn(final Parser parser, final Date date, final String data) {

test/com/dmdirc/harness/TestWritableFrameContainer.java

@@ -59,16 +59,6 @@ public class TestWritableFrameContainer extends WritableFrameContainer {
         return lineLength;
     }
 
-    @Override
-    public void windowClosing() {
-        // Do nothing
-    }
-
-    @Override
-    public void windowClosed() {
-        // Do nothing
-    }
-
     @Override
     public Connection getConnection() {
         return null;