Introduced an ActionMetaType interface so plugins (etc) can define their own meta-types

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

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

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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 uk.org.ownage.dmdirc.actions;
+
+/**
+ * Encapsulates the methods that all action types are required to implement.
+ * @author chris
+ */
+public interface ActionMetaType {
+    
+    /**
+     * Retrieves the arity of this type.
+     * @return The arity of this action type
+     */
+    int getArity();
+    
+    /**
+     * Retrieves the type of arguments that actions of this type should expect.
+     * @return The type of arguments expected
+     */
+    Class[] getArgTypes();
+    
+}

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

@@ -32,6 +32,6 @@ public interface ActionType {
      * Retrieves the type of this action.
      * @return This action's type
      */
-    CoreActionMetaType getType();
+    ActionMetaType getType();
     
 }

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

@@ -32,7 +32,7 @@ import uk.org.ownage.dmdirc.parser.ChannelClientInfo;
  * parameters an action expects).
  * @author chris
  */
-public enum CoreActionMetaType {
+public enum CoreActionMetaType implements ActionMetaType {
     
     SERVER_EVENT(1, Server.class),
     CHANNEL_EVENT(1, Channel.class),
@@ -53,7 +53,7 @@ public enum CoreActionMetaType {
     
     /**
      * Constructs an instance of an CoreActionMetaType.
-     * 
+     *
      * @param arity The arity of the action type
      */
     CoreActionMetaType(final int arity, final Class ... argTypes) {
@@ -61,20 +61,12 @@ public enum CoreActionMetaType {
         this.argTypes = argTypes;
     }
     
-    /**
-     * Retrieves the arity of an CoreActionMetaType.
-     * 
-     * @return The arity of this action type
-     */
+    /** {@inheritDoc} */
     public int getArity() {
         return arity;
     }
     
-    /**
-     * Retrieves the type of arguments that actiontypes of this metatype should
-     * expect.
-     * @return The type of arguments expected
-     */
+    /** {@inheritDoc} */
     public Class[] getArgTypes() {
         return argTypes.clone();
     }

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

@@ -60,13 +60,13 @@ public enum CoreActionType implements ActionType {
     CHANNEL_TOPICCHANGE(CoreActionMetaType.CHANNEL_SOURCED_EVENT_WITH_ARG);
     
     /** The type of this action. */
-    private final CoreActionMetaType type;
+    private final ActionMetaType type;
     
     /**
      * Constructs a new core action.
      * @param type The type of this action
      */
-    CoreActionType(CoreActionMetaType type) {
+    CoreActionType(ActionMetaType type) {
         this.type = type;
     }
     
@@ -74,7 +74,7 @@ public enum CoreActionType implements ActionType {
      * Retrieves the type of this action.
      * @return This action's type
      */
-    public CoreActionMetaType getType() {
+    public ActionMetaType getType() {
         return type;
     }