Dependency inject message sinks.

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

src/com/dmdirc/ClientModule.java

@@ -46,7 +46,7 @@ import com.dmdirc.interfaces.config.IdentityFactory;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.ErrorManager;
 import com.dmdirc.logger.Logger;
-import com.dmdirc.messages.MessageSinkManager;
+import com.dmdirc.messages.MessagesModule;
 import com.dmdirc.plugins.LegacyServiceLocator;
 import com.dmdirc.plugins.PluginInjectorInitialiser;
 import com.dmdirc.plugins.PluginManager;
@@ -55,8 +55,6 @@ import com.dmdirc.plugins.ServiceLocator;
 import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.ui.WarningDialog;
-import com.dmdirc.ui.WindowManager;
-import com.dmdirc.ui.core.components.StatusBarManager;
 import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.themes.ThemeManager;
 import com.dmdirc.updater.UpdaterModule;
@@ -90,6 +88,7 @@ import dagger.Provides;
             AliasesModule.class,
             CommandLineOptionsModule.class,
             CommandModule.class,
+            MessagesModule.class,
             UpdaterModule.class
         },
         library = true)
@@ -197,17 +196,6 @@ public class ClientModule {
         return controller;
     }
 
-    @Provides
-    @Singleton
-    public MessageSinkManager getMessageSinkManager(
-            final StatusBarManager statusBarManager,
-            final WindowManager windowManager,
-            final URLBuilder urlBuilder) {
-        final MessageSinkManager messageSinkManager = new MessageSinkManager();
-        messageSinkManager.loadDefaultSinks(statusBarManager, windowManager, urlBuilder);
-        return messageSinkManager;
-    }
-
     @Provides
     @Singleton
     public CommandManager getCommandManager(

src/com/dmdirc/messages/AllMessageSink.java

@@ -27,6 +27,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to all of the container's server's children.
  */
@@ -35,6 +37,10 @@ public class AllMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("all");
 
+    @Inject
+    public AllMessageSink() {
+    }
+
     @Override
     public Pattern getPattern() {
         return PATTERN;

src/com/dmdirc/messages/ChannelMessageSink.java

@@ -28,6 +28,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to a named channel. An optional fallback may be specified
  * for use if the channel does not exist. If no fallback is specified and the channel does not
@@ -38,6 +40,10 @@ public class ChannelMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("channel:(.*?)(?:\\s(.*))?");
 
+    @Inject
+    public ChannelMessageSink() {
+    }
+
     @Override
     public Pattern getPattern() {
         return PATTERN;

src/com/dmdirc/messages/CommonChanelsMessageSink.java

@@ -28,6 +28,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to all channels the local user has in common with a
  * specified remote user. An optional fallback may be specified for use if there are no common
@@ -39,6 +41,10 @@ public class CommonChanelsMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("comchans:(.*?)(?:\\s(.*))?");
 
+    @Inject
+    public CommonChanelsMessageSink() {
+    }
+
     @Override
     public Pattern getPattern() {
         return PATTERN;

src/com/dmdirc/messages/CustomWindowMessageSink.java

@@ -31,6 +31,8 @@ import com.dmdirc.util.URLBuilder;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to a custom window, creating it if necessary.
  */
@@ -49,6 +51,7 @@ public class CustomWindowMessageSink implements MessageSink {
      * @param windowManager Window management
      * @param urlBuilder    The URL builder to use when finding icons.
      */
+    @Inject
     public CustomWindowMessageSink(
             final WindowManager windowManager,
             final URLBuilder urlBuilder) {

src/com/dmdirc/messages/ForkMessageSink.java

@@ -27,6 +27,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which allows the message to be forked into multiple other sinks.
  */
@@ -35,6 +37,10 @@ public class ForkMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("fork:(.*)");
 
+    @Inject
+    public ForkMessageSink() {
+    }
+
     @Override
     public Pattern getPattern() {
         return PATTERN;

src/com/dmdirc/messages/FormatMessageSink.java

@@ -27,6 +27,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which changes the format of the message and then redespatches it.
  */
@@ -35,6 +37,10 @@ public class FormatMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("format:(.*?):(.*)");
 
+    @Inject
+    public FormatMessageSink() {
+    }
+
     @Override
     public Pattern getPattern() {
         return PATTERN;

src/com/dmdirc/messages/GroupMessageSink.java

@@ -27,6 +27,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which changes the sink to the value of a named configuration setting to allow
  * grouping of sinks.
@@ -36,6 +38,10 @@ public class GroupMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("group:(.*)");
 
+    @Inject
+    public GroupMessageSink() {
+    }
+
     /** {@inheritDoc} */
     @Override
     public Pattern getPattern() {

src/com/dmdirc/messages/LastCommandMessageSink.java

@@ -30,6 +30,8 @@ import java.util.Date;
 import java.util.List;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to the window where a command matching the provided regex
  * was most recently executed. If no such window is found, falls back to the source.
@@ -39,6 +41,10 @@ public class LastCommandMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("lastcommand:(.*)");
 
+    @Inject
+    public LastCommandMessageSink() {
+    }
+
     /** {@inheritDoc} */
     @Override
     public Pattern getPattern() {

src/com/dmdirc/messages/MessageSinkManager.java

@@ -25,9 +25,6 @@ package com.dmdirc.messages;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
-import com.dmdirc.ui.WindowManager;
-import com.dmdirc.ui.core.components.StatusBarManager;
-import com.dmdirc.util.URLBuilder;
 
 import java.util.ArrayList;
 import java.util.Date;
@@ -121,30 +118,4 @@ public class MessageSinkManager {
         }
     }
 
-    /**
-     * Loads the default message sinks into this manager.
-     *
-     * @param statusBarManager The status bar manager to give to status-bar related sinks.
-     * @param windowManager    The window manager to give to sinks that iterate windows.
-     * @param urlBuilder       The URL builder to use when finding icons.
-     */
-    public void loadDefaultSinks(
-            final StatusBarManager statusBarManager,
-            final WindowManager windowManager,
-            final URLBuilder urlBuilder) {
-        // TODO: Dependency inject all these.
-        addSink(new AllMessageSink());
-        addSink(new ChannelMessageSink());
-        addSink(new CommonChanelsMessageSink());
-        addSink(new CustomWindowMessageSink(windowManager, urlBuilder));
-        addSink(new ForkMessageSink());
-        addSink(new FormatMessageSink());
-        addSink(new GroupMessageSink());
-        addSink(new LastCommandMessageSink());
-        addSink(new NullMessageSink());
-        addSink(new SelfMessageSink());
-        addSink(new ServerMessageSink());
-        addSink(new StatusBarMessageSink(statusBarManager));
-    }
-
 }

src/com/dmdirc/messages/MessagesModule.java

@@ -0,0 +1,108 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.messages;
+
+import java.util.Set;
+
+import javax.inject.Singleton;
+
+import dagger.Module;
+import dagger.Provides;
+
+/**
+ * Module for dependency injecting the {@link MessageSinkManager} and its default sinks.
+ */
+@Module(library = true, complete = false)
+public class MessagesModule {
+
+    @Provides
+    @Singleton
+    public MessageSinkManager getMessageSinkManager(final Set<MessageSink> defaultSinks) {
+        final MessageSinkManager messageSinkManager = new MessageSinkManager();
+        for (MessageSink sink : defaultSinks) {
+            messageSinkManager.addSink(sink);
+        }
+        return messageSinkManager;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final AllMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final ChannelMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final CommonChanelsMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final CustomWindowMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final ForkMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final FormatMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final GroupMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final LastCommandMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final NullMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final SelfMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final ServerMessageSink sink) {
+        return sink;
+    }
+
+    @Provides(type = Provides.Type.SET)
+    public MessageSink getMessageSink(final StatusBarMessageSink sink) {
+        return sink;
+    }
+
+}

src/com/dmdirc/messages/NullMessageSink.java

@@ -27,6 +27,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which does nothing with the message.
  */
@@ -35,6 +37,10 @@ public class NullMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("none");
 
+    @Inject
+    public NullMessageSink() {
+    }
+
     /** {@inheritDoc} */
     @Override
     public Pattern getPattern() {

src/com/dmdirc/messages/SelfMessageSink.java

@@ -27,6 +27,8 @@ import com.dmdirc.FrameContainer;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to the container that despatched it.
  */
@@ -35,6 +37,10 @@ public class SelfMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("self");
 
+    @Inject
+    public SelfMessageSink() {
+    }
+
     /** {@inheritDoc} */
     @Override
     public Pattern getPattern() {

src/com/dmdirc/messages/ServerMessageSink.java

@@ -28,6 +28,8 @@ import com.dmdirc.Server;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to the container's server.
  */
@@ -36,6 +38,10 @@ public class ServerMessageSink implements MessageSink {
     /** The pattern to use to match this sink. */
     private static final Pattern PATTERN = Pattern.compile("server");
 
+    @Inject
+    public ServerMessageSink() {
+    }
+
     /** {@inheritDoc} */
     @Override
     public Pattern getPattern() {

src/com/dmdirc/messages/StatusBarMessageSink.java

@@ -30,6 +30,8 @@ import com.dmdirc.ui.messages.Formatter;
 import java.util.Date;
 import java.util.regex.Pattern;
 
+import javax.inject.Inject;
+
 /**
  * A message sink which adds the message to the status bar.
  */
@@ -45,6 +47,7 @@ public class StatusBarMessageSink implements MessageSink {
      *
      * @param statusBarManager The status bar manager to add messages to.
      */
+    @Inject
     public StatusBarMessageSink(final StatusBarManager statusBarManager) {
         this.statusBarManager = statusBarManager;
     }