DI the time plugin.

Change-Id: I271d24e61936ddb3930339207f575af646598320
Reviewed-on: http://gerrit.dmdirc.com/3224
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/time/TimeActionMetaType.java

@@ -28,33 +28,27 @@ import java.util.Calendar;
 
 /**
  * Encapsulates the meta types used by the various time actions.
- *
- * @author chris
  */
 public enum TimeActionMetaType implements ActionMetaType {
 
     /** Time type. */
     TIME_TIME {
-        /** {@inheritDoc} */
-        @Override
-        public int getArity() {
-            return 1;
-        }
-
-        /** {@inheritDoc} */
-        @Override
-        public Class[] getArgTypes() {
-            return new Class[]{Calendar.class};
-        }
-
-        /** {@inheritDoc} */
-        @Override
-        public String[] getArgNames() {
-            return new String[]{"Date"};
-        }
-    };
-
-    /** {@inheritDoc} */
+                @Override
+                public int getArity() {
+                    return 1;
+                }
+
+                @Override
+                public Class[] getArgTypes() {
+                    return new Class<?>[]{Calendar.class};
+                }
+
+                @Override
+                public String[] getArgNames() {
+                    return new String[]{"Date"};
+                }
+            };
+
     @Override
     public String getGroup() {
         return "Time Events";

src/com/dmdirc/addons/time/TimeActionType.java

@@ -27,8 +27,6 @@ import com.dmdirc.interfaces.actions.ActionType;
 
 /**
  * Lists the actions that the time plugin will raise.
- *
- * @author chris
  */
 public enum TimeActionType implements ActionType {
 
@@ -50,13 +48,11 @@ public enum TimeActionType implements ActionType {
         this.name = name;
     }
 
-    /** {@inheritDoc} */
     @Override
     public ActionMetaType getType() {
         return TimeActionMetaType.TIME_TIME;
     }
 
-    /** {@inheritDoc} */
     @Override
     public String getName() {
         return name;

src/com/dmdirc/addons/time/TimeModule.java

@@ -0,0 +1,32 @@
+/*
+ * 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.addons.time;
+
+import com.dmdirc.ClientModule;
+
+import dagger.Module;
+
+@Module(injects = {TimerCommand.class, TimerManager.class}, addsTo = ClientModule.class)
+public class TimeModule {
+
+}

src/com/dmdirc/addons/time/TimePlugin.java

@@ -22,98 +22,39 @@
 
 package com.dmdirc.addons.time;
 
-import com.dmdirc.interfaces.ActionController;
-import com.dmdirc.interfaces.CommandController;
+import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
 
-import java.util.Calendar;
-import java.util.Timer;
-import java.util.TimerTask;
+import dagger.ObjectGraph;
 
 /**
  * Provides various time-related features.
  */
 public class TimePlugin extends BaseCommandPlugin {
 
-    /** Have we registered our types already? */
-    private static boolean registered;
-    /** The timer to use for scheduling. */
-    private Timer timer;
     /** The Manager to use for managing timers. */
     private TimerManager manager;
-    /** The action controller to use. */
-    private final ActionController actionController;
 
-    /**
-     * Creates a new instance of this plugin.
-     *
-     * @param actionController  The action controller to register listeners with
-     * @param commandController Command controller to register commands
-     */
-    public TimePlugin(
-            final ActionController actionController,
-            final CommandController commandController) {
-        this.actionController = actionController;
-        manager = new TimerManager(commandController);
-        registerCommand(new TimerCommand(manager, commandController), TimerCommand.INFO);
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new TimeModule()));
+        registerCommand(TimerCommand.class, TimerCommand.INFO);
+        manager = getObjectGraph().get(TimerManager.class);
     }
 
     /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        if (!registered) {
-            actionController.registerTypes(TimeActionType.values());
-            registered = true;
-        }
-
-        final int offset = 60 - Calendar.getInstance().get(Calendar.SECOND);
-
-        timer = new Timer("Time plugin timer");
-
-        timer.schedule(new TimerTask() {
-            /** {@inheritDoc} */
-            @Override
-            public void run() {
-                runTimer();
-            }
-        }, 1000 * offset, 1000 * 60);
+        manager.load();
         super.onLoad();
     }
 
-    /** Handles a timer event that occurs every minute. */
-    public void runTimer() {
-        final Calendar cal = Calendar.getInstance();
-
-        actionController.triggerEvent(TimeActionType.TIME_MINUTE, null, cal);
-
-        if (cal.get(Calendar.MINUTE) == 0) {
-            actionController.triggerEvent(TimeActionType.TIME_HOUR, null, cal);
-
-            if (cal.get(Calendar.HOUR_OF_DAY) == 0) {
-                actionController.triggerEvent(TimeActionType.TIME_DAY, null, cal);
-            }
-        }
-    }
-
     /** {@inheritDoc} */
     @Override
     public void onUnload() {
-        if (timer != null) {
-            timer.cancel();
-            timer = null;
-        }
-        manager = null;
-
+        manager.unload();
         super.onUnload();
     }
 
-    /**
-     * Returns the manager that is assigned to this Plugin.
-     *
-     * @return The Instance of TimeManager that is associated with this plugin
-     */
-    public TimerManager getTimerManager() {
-        return manager;
-    }
-
 }

src/com/dmdirc/addons/time/TimedCommand.java

@@ -31,6 +31,7 @@ import com.dmdirc.interfaces.CommandController;
 import java.util.Timer;
 import java.util.TimerTask;
 
+
 /**
  * Timed command represents a command that has been scheduled by the user.
  */
@@ -85,8 +86,6 @@ public class TimedCommand extends TimerTask {
      * Returns the command this timer is due to execute.
      *
      * @return Command the timer will run
-     *
-     * @since 0.6.5
      */
     public String getCommand() {
         return command;
@@ -94,15 +93,12 @@ public class TimedCommand extends TimerTask {
 
     /**
      * Cancels this timer and removes it from the Timer Manager
-     *
-     * @since 0.6.5
      */
     public void cancelTimer() {
         manager.removeTimer(timerKey);
         timer.cancel();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void run() {
         CommandParser parser;

src/com/dmdirc/addons/time/TimerCommand.java

@@ -35,6 +35,9 @@ import com.dmdirc.ui.input.AdditionalTabTargets;
 import java.util.Map.Entry;
 import java.util.Set;
 
+import javax.inject.Inject;
+
+
 /**
  * The timer command allows users to schedule commands to occur after a certain interval, or to
  * repeatedly occur with a specified delay.
@@ -57,13 +60,13 @@ public class TimerCommand extends Command implements IntelligentCommand {
      * @param manager           The instance of TimerManager associated with this command
      * @param commandController The controller to use for command information.
      */
+    @Inject
     public TimerCommand(final TimerManager manager, final CommandController commandController) {
         super(commandController);
 
         this.manager = manager;
     }
 
-    /** {@inheritDoc} */
     @Override
     public void execute(final FrameContainer origin,
             final CommandArguments args, final CommandContext context) {
@@ -145,7 +148,6 @@ public class TimerCommand extends Command implements IntelligentCommand {
                 + "<repetitions> <interval> <command>]");
     }
 
-    /** {@inheritDoc} */
     @Override
     public AdditionalTabTargets getSuggestions(final int arg,
             final IntelligentCommandContext context) {

src/com/dmdirc/addons/time/TimerManager.java

@@ -23,17 +23,21 @@
 package com.dmdirc.addons.time;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.interfaces.ActionController;
 import com.dmdirc.interfaces.CommandController;
 
+import java.util.Calendar;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
+import java.util.Timer;
+import java.util.TimerTask;
+
+import javax.inject.Inject;
 
 /**
  * Class to manage Timers.
- *
- * @since 0.6.5
  */
 public class TimerManager {
 
@@ -41,9 +45,44 @@ public class TimerManager {
     private final Map<Integer, TimedCommand> timerList = new HashMap<>();
     /** The command controller to use when executing global commands. */
     private final CommandController commandController;
+    /** Action controller. */
+    private final ActionController actionController;
+    /** Have we registered our types already? */
+    private static boolean registered;
+    /** The timer to use for scheduling. */
+    private Timer timer;
 
-    public TimerManager(final CommandController commandController) {
+    @Inject
+    public TimerManager(final CommandController commandController,
+            final ActionController actionController) {
         this.commandController = commandController;
+        this.actionController = actionController;
+    }
+
+    public void load() {
+        if (!registered) {
+            actionController.registerTypes(TimeActionType.values());
+            registered = true;
+        }
+
+        final int offset = 60 - Calendar.getInstance().get(Calendar.SECOND);
+
+        timer = new Timer("Time plugin timer");
+
+        timer.schedule(new TimerTask() {
+            /** {@inheritDoc} */
+            @Override
+            public void run() {
+                runTimer();
+            }
+        }, 1000 * offset, 1000 * 60);
+    }
+
+    public void unload() {
+        if (timer != null) {
+            timer.cancel();
+            timer = null;
+        }
     }
 
     /**
@@ -128,4 +167,19 @@ public class TimerManager {
         return timerList.containsKey(id);
     }
 
+    /** Handles a timer event that occurs every minute. */
+    public void runTimer() {
+        final Calendar cal = Calendar.getInstance();
+
+        actionController.triggerEvent(TimeActionType.TIME_MINUTE, null, cal);
+
+        if (cal.get(Calendar.MINUTE) == 0) {
+            actionController.triggerEvent(TimeActionType.TIME_HOUR, null, cal);
+
+            if (cal.get(Calendar.HOUR_OF_DAY) == 0) {
+                actionController.triggerEvent(TimeActionType.TIME_DAY, null, cal);
+            }
+        }
+    }
+
 }