Action Types now have a user-friendly name

git-svn-id: http://svn.dmdirc.com/trunk@1159 00569f92-eb28-0410-84fd-f71c24880f

src/uk/org/ownage/dmdirc/actions/ActionType.java

@@ -34,4 +34,10 @@ public interface ActionType {
      */
     ActionMetaType getType();
     
+    /**
+     * Retrieves this type's name.
+     * @return The name of this type
+     */
+    String getName();
+    
 }

src/uk/org/ownage/dmdirc/actions/CoreActionType.java

@@ -28,64 +28,75 @@ package uk.org.ownage.dmdirc.actions;
  */
 public enum CoreActionType implements ActionType {
     
-    UNKNOWN_COMMAND(CoreActionMetaType.UNKNOWN_COMMAND),
+    UNKNOWN_COMMAND(CoreActionMetaType.UNKNOWN_COMMAND, "Unknown command entered"),
     
-    SERVER_CONNECTED(CoreActionMetaType.SERVER_EVENT),
-    SERVER_BACK(CoreActionMetaType.SERVER_EVENT),
-    SERVER_AWAY(CoreActionMetaType.SERVER_EVENT_WITH_ARG),
+    SERVER_CONNECTED(CoreActionMetaType.SERVER_EVENT, "Server connected"),
+    SERVER_BACK(CoreActionMetaType.SERVER_EVENT, "Marked as 'back'"),
+    SERVER_AWAY(CoreActionMetaType.SERVER_EVENT_WITH_ARG, "Marked as 'away'"),
     
-    SERVER_GOTPING(CoreActionMetaType.SERVER_PING),
-    SERVER_NOPING(CoreActionMetaType.SERVER_PING),
+    SERVER_GOTPING(CoreActionMetaType.SERVER_PING, "Received server ping reply"),
+    SERVER_NOPING(CoreActionMetaType.SERVER_PING, "Missed server ping reply"),
     
-    QUERY_OPENED(CoreActionMetaType.QUERY_EVENT),
-    QUERY_CLOSED(CoreActionMetaType.QUERY_EVENT),
-    QUERY_MESSAGE(CoreActionMetaType.QUERY_EVENT_WITH_ARG),
-    QUERY_ACTION(CoreActionMetaType.QUERY_EVENT_WITH_ARG),
-    QUERY_SELF_MESSAGE(CoreActionMetaType.QUERY_EVENT_WITH_ARG),
-    QUERY_SELF_ACTION(CoreActionMetaType.QUERY_EVENT_WITH_ARG),    
+    QUERY_OPENED(CoreActionMetaType.QUERY_EVENT, "Query window opened"),
+    QUERY_CLOSED(CoreActionMetaType.QUERY_EVENT, "Query window closed"),
+    QUERY_MESSAGE(CoreActionMetaType.QUERY_EVENT_WITH_ARG, "Private message received"),
+    QUERY_ACTION(CoreActionMetaType.QUERY_EVENT_WITH_ARG, "Private action received"),
+    QUERY_SELF_MESSAGE(CoreActionMetaType.QUERY_EVENT_WITH_ARG, "Private message sent"),
+    QUERY_SELF_ACTION(CoreActionMetaType.QUERY_EVENT_WITH_ARG, "Private action sent"),
     
-    CHANNEL_OPENED(CoreActionMetaType.CHANNEL_EVENT),
-    CHANNEL_CLOSED(CoreActionMetaType.CHANNEL_EVENT),
-    CHANNEL_GOTNAMES(CoreActionMetaType.CHANNEL_EVENT),
-    CHANNEL_GOTTOPIC(CoreActionMetaType.CHANNEL_EVENT),
+    CHANNEL_OPENED(CoreActionMetaType.CHANNEL_EVENT, "Channel window opened"),
+    CHANNEL_CLOSED(CoreActionMetaType.CHANNEL_EVENT, "Channel window closed"),
+    CHANNEL_GOTNAMES(CoreActionMetaType.CHANNEL_EVENT, "Channel names reply received"),
+    CHANNEL_GOTTOPIC(CoreActionMetaType.CHANNEL_EVENT, "Channel topic received"),
     
-    CHANNEL_SELF_MESSAGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
-    CHANNEL_SELF_ACTION(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
+    CHANNEL_SELF_MESSAGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel message sent"),
+    CHANNEL_SELF_ACTION(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel action sent"),
     
-    CHANNEL_MESSAGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
-    CHANNEL_ACTION(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
+    CHANNEL_MESSAGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel message received"),
+    CHANNEL_ACTION(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel action received"),
     
-    CHANNEL_JOIN(CoreActionMetaType.CHANNEL_SOURCED_EVENT),
-    CHANNEL_PART(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
-    CHANNEL_QUIT(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
-    CHANNEL_KICK(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_VICTIM),
+    CHANNEL_JOIN(CoreActionMetaType.CHANNEL_SOURCED_EVENT, "Someone joined a channel"),
+    CHANNEL_PART(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone left a channel"),
+    CHANNEL_QUIT(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone quit IRC"),
+    CHANNEL_KICK(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_VICTIM, "Someone kicked someone"),
     
-    CHANNEL_USERAWAY(CoreActionMetaType.CHANNEL_SOURCED_EVENT),
-    CHANNEL_USERBACK(CoreActionMetaType.CHANNEL_SOURCED_EVENT),
+    CHANNEL_USERAWAY(CoreActionMetaType.CHANNEL_SOURCED_EVENT, "Someone is marked as 'away'"),
+    CHANNEL_USERBACK(CoreActionMetaType.CHANNEL_SOURCED_EVENT, "Someone is marked as 'back'"),
     
-    CHANNEL_MODECHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
+    CHANNEL_MODECHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone changed channel modes"),
     
-    CHANNEL_NICKCHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG),
+    CHANNEL_NICKCHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone changed nicknames"),
     
-    CHANNEL_TOPICCHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG);
+    CHANNEL_TOPICCHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone changed channel topic");
     
     /** The type of this action. */
     private final ActionMetaType type;
     
+    /** The name of this action. */
+    private final String name;
+    
     /**
      * Constructs a new core action.
      * @param type The type of this action
      */
-    CoreActionType(ActionMetaType type) {
+    CoreActionType(final ActionMetaType type, final String name) {
         this.type = type;
+        this.name = name;
     }
     
-    /**
-     * Retrieves the type of this action.
-     * @return This action's type
-     */
+    /** {@inheritDoc} */
     public ActionMetaType getType() {
         return type;
     }
     
+    /** {@inheritDoc} */
+    public String getName() {
+        return name;
+    }
+    
+    /** {@inheritDoc} */
+    public String toString() {
+        return getName();
+    }
+    
 }

src/uk/org/ownage/dmdirc/plugins/plugins/timeplugin/TimeActionType.java

@@ -30,12 +30,34 @@ import uk.org.ownage.dmdirc.actions.ActionType;
  * @author chris
  */
 public enum TimeActionType implements ActionType {
-
-    TIME_MINUTE, TIME_HOUR, TIME_DAY;
+    
+    TIME_MINUTE("Every minute"),
+    TIME_HOUR("Every hour"),
+    TIME_DAY("Every day");
+    
+    private final String name;
+    
+    /**
+     * Creates a new instance of a TimeActionType.
+     * @param name The name of the action type
+     */
+    TimeActionType(final String name) {
+        this.name = name;
+    }
     
     /** {@inheritDoc} */
     public ActionMetaType getType() {
         return TimeActionMetaType.TIME_TIME;
     }
     
+    /** {@inheritDoc} */
+    public String getName() {
+        return name;
+    }
+    
+    /** {@inheritDoc} */
+    public String toString() {
+        return getName();
+    }
+    
 }