Status bar deprecation in core

Change-Id: Ie3c22f9bba6b43fe3caeca86957b6031dc3a0808
Reviewed-on: http://gerrit.dmdirc.com/1855
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/Server.java

@@ -48,6 +48,7 @@ import com.dmdirc.parser.interfaces.Parser;
 import com.dmdirc.parser.interfaces.ProtocolDescription;
 import com.dmdirc.parser.interfaces.SecureParser;
 import com.dmdirc.parser.interfaces.StringConverter;
+import com.dmdirc.ui.StatusMessage;
 import com.dmdirc.ui.WindowManager;
 import com.dmdirc.ui.core.components.StatusBarManager;
 import com.dmdirc.ui.input.TabCompleter;
@@ -1510,10 +1511,10 @@ public class Server extends WritableFrameContainer<ServerWindow> implements Conf
      * Called when we fail to receive a ping reply within a set period of time.
      */
     public void onPingFailed() {
-        StatusBarManager.getStatusBarManager().setMessage("No ping reply from "
-                + getName() + " for over "
+        StatusBarManager.getStatusBarManager().setMessage(new StatusMessage(
+                "No ping reply from " + getName() + " for over "
                 + ((int) (Math.floor(parser.getPingTime() / 1000.0)))
-                + " seconds.", null, 10);
+                + " seconds."));
 
         ActionManager.getActionManager().triggerEvent(
                 CoreActionType.SERVER_NOPING, null, this,

src/com/dmdirc/ui/StatusMessage.java

@@ -41,9 +41,10 @@ public class StatusMessage {
     /**
      * Creates a new statusbar message.
      *
-     * @param iconType Icon type to use for the message
+     * @param iconType Icon type to use for the message (can be null)
      * @param message Message to show
-     * @param messageNotifier Optional notifier
+     * @param messageNotifier Optional notifier (can be null)
+     * @param timeout message timeout (can be -1)
      */
     public StatusMessage(final String iconType, final String message,
             final StatusMessageNotifier messageNotifier, final int timeout) {
@@ -53,6 +54,19 @@ public class StatusMessage {
         this.timeout = timeout;
     }
 
+    /**
+     * Creates a new statusbar message.  This will show no icon, won't have a
+     * message notifier and will time out in the default timeout.
+     *
+     * @param message Message to show
+     */
+    public StatusMessage(final String message) {
+        this.iconType = null;
+        this.message = message;
+        this.messageNotifier = null;
+        this.timeout = -1;
+    }
+
     /**
      * Get the value of message
      *

src/com/dmdirc/ui/core/components/StatusBarManager.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.ui.core.components;
 
+import com.dmdirc.ui.StatusMessage;
 import com.dmdirc.ui.interfaces.StatusBar;
 import com.dmdirc.ui.interfaces.StatusBarComponent;
 import com.dmdirc.ui.interfaces.StatusMessageNotifier;
@@ -33,7 +34,6 @@ import java.util.concurrent.CopyOnWriteArraySet;
  * A manager for status bars or status bar like components.
  *
  * @since 0.6.5
- * @author chris
  */
 public class StatusBarManager implements StatusBar {
 
@@ -43,16 +43,6 @@ public class StatusBarManager implements StatusBar {
     /** A collection of known status bars. */
     private final Collection<StatusBar> statusBars = new CopyOnWriteArraySet<StatusBar>();
 
-    /**
-     * Creates a new instance of the StatusBarManager.
-     * <p>
-     * <strong>You probably want to use {@link #getStatusBarManager()} instead
-     * of creating a new instance.</strong>
-     */
-    public StatusBarManager() {
-        // Do nothing
-    }
-
     /**
      * Registers a new status bar with the manager. All requests to
      * interact with status bars will be passed on to this status bar until
@@ -73,7 +63,11 @@ public class StatusBarManager implements StatusBar {
         statusBars.remove(statusBar);
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
+     */
+    @Deprecated
     @Override
     public void setMessage(final String newMessage) {
         for (StatusBar statusBar : statusBars) {
@@ -81,7 +75,11 @@ public class StatusBarManager implements StatusBar {
         }
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
+     */
+    @Deprecated
     @Override
     public void setMessage(final String iconType, final String newMessage) {
         for (StatusBar statusBar : statusBars) {
@@ -89,7 +87,11 @@ public class StatusBarManager implements StatusBar {
         }
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
+     */
+    @Deprecated
     @Override
     public void setMessage(final String newMessage,
             final StatusMessageNotifier newNotifier) {
@@ -98,7 +100,11 @@ public class StatusBarManager implements StatusBar {
         }
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
+     */
+    @Deprecated
     @Override
     public void setMessage(final String iconType, final String newMessage,
             final StatusMessageNotifier newNotifier) {
@@ -107,7 +113,11 @@ public class StatusBarManager implements StatusBar {
         }
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
+     */
+    @Deprecated
     @Override
     public void setMessage(final String newMessage,
             final StatusMessageNotifier newNotifier, final int timeout) {
@@ -116,7 +126,11 @@ public class StatusBarManager implements StatusBar {
         }
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
+     */
+    @Deprecated
     @Override
     public void setMessage(final String iconType, final String newMessage,
             final StatusMessageNotifier newNotifier, final int timeout) {
@@ -125,6 +139,14 @@ public class StatusBarManager implements StatusBar {
         }
     }
 
+    /** {@inheritDoc} */
+    @Override
+    public void setMessage(final StatusMessage message) {
+        for (StatusBar statusBar : statusBars) {
+            statusBar.setMessage(message);
+        }
+    }
+
     /** {@inheritDoc} */
     @Override
     public void clearMessage() {

src/com/dmdirc/ui/core/util/URLHandler.java

@@ -27,6 +27,7 @@ import com.dmdirc.config.ConfigManager;
 import com.dmdirc.config.IdentityManager;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.ui.StatusMessage;
 import com.dmdirc.ui.core.components.StatusBarManager;
 import com.dmdirc.ui.interfaces.UIController;
 
@@ -155,16 +156,18 @@ public class URLHandler {
         final String command = config.getOption("protocol", uri.getScheme().toLowerCase());
 
         if ("DMDIRC".equals(command)) {
-            StatusBarManager.getStatusBarManager().setMessage("Connecting to: "
-                    + uri.toString());
+            StatusBarManager.getStatusBarManager().setMessage(
+                    new StatusMessage("Connecting to: " + uri.toString()));
             ServerManager.getServerManager().connectToAddress(uri);
         } else if ("BROWSER".equals(command)) {
-            StatusBarManager.getStatusBarManager().setMessage("Opening: " + uri.toString());
+            StatusBarManager.getStatusBarManager().setMessage(
+                    new StatusMessage("Opening: " + uri.toString()));
             execBrowser(uri);
         } else if ("MAIL".equals(command)) {
             execMail(uri);
         } else {
-            StatusBarManager.getStatusBarManager().setMessage("Opening: " + uri.toString());
+            StatusBarManager.getStatusBarManager().setMessage(
+                    new StatusMessage("Opening: " + uri.toString()));
             execApp(substituteParams(uri, command));
         }
     }

src/com/dmdirc/ui/interfaces/StatusBar.java

@@ -22,6 +22,8 @@
 
 package com.dmdirc.ui.interfaces;
 
+import com.dmdirc.ui.StatusMessage;
+
 /**
  * Status bar interface.
  */
@@ -31,7 +33,10 @@ public interface StatusBar {
      * sets the message in the status bar.
      *
      * @param newMessage Message to display
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
+    @Deprecated
     void setMessage(final String newMessage);
 
     /**
@@ -41,7 +46,10 @@ public interface StatusBar {
      * @param newMessage Message to display
      *
      * @since 0.6
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
+    @Deprecated
     void setMessage(final String iconType, final String newMessage);
 
     /**
@@ -53,7 +61,10 @@ public interface StatusBar {
      * this message
      *
      * @since 0.6
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
+    @Deprecated
     void setMessage(final String newMessage,
             final StatusMessageNotifier newNotifier);
 
@@ -67,7 +78,10 @@ public interface StatusBar {
      * this message
      *
      * @since 0.6
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
+    @Deprecated
     void setMessage(final String iconType, final String newMessage,
             final StatusMessageNotifier newNotifier);
 
@@ -79,7 +93,10 @@ public interface StatusBar {
      * @param newNotifier status message notifier to be notified for events on
      * this message
      * @param timeout message timeout in seconds
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
+    @Deprecated
     void setMessage(final String newMessage,
             final StatusMessageNotifier newNotifier, final int timeout);
 
@@ -94,10 +111,22 @@ public interface StatusBar {
      * @param timeout message timeout in seconds
      *
      * @since 0.6
+     *
+     * @deprecated Should use {@link setMessage(StatusMessage)} instead
      */
+    @Deprecated
     void setMessage(final String iconType, final String newMessage,
             final StatusMessageNotifier newNotifier, final int timeout);
 
+    /**
+     * Sets the message for this message label.
+     *
+     * @param message Message object to show
+     *
+     * @since 0.6.6
+     */
+    void setMessage(final StatusMessage message);
+
     /**
      * Removes the message from the status bar.
      */