1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.actions.metatypes;
    24  
    25  import com.dmdirc.actions.interfaces.ActionMetaType;
    26  import com.dmdirc.plugins.PluginInfo;
    27  
    28  /**
    29   * Defines plugin-related events.
    30   *
    31   * @author Chris
    32   */
         /* 
    P/P   *  Method: PluginEvents valueOf(String)
          * 
          *  Postconditions:
          *    init'ed(return_value)
          */
    33  public enum PluginEvents implements ActionMetaType {
    34      
    35      /** Plugin event type. */
             /* 
    P/P       *  Method: com.dmdirc.actions.metatypes.PluginEvents__static_init
              * 
              *  Postconditions:
              *    $VALUES == &new PluginEvents[](PluginEvents__static_init#4)
              *    PLUGIN_EVENT == &new PluginEvents(PluginEvents__static_init#1)
              *    $VALUES[0] == &new PluginEvents(PluginEvents__static_init#1)
              *    new Class[](PluginEvents__static_init#3) num objects == 1
              *    PLUGIN_EVENT.argTypes.length == 1
              *    new PluginEvents(PluginEvents__static_init#1) num objects == 1
              *    new PluginEvents[](PluginEvents__static_init#4) num objects == 1
              *    $VALUES.length == 1
              *    new String[](PluginEvents__static_init#2) num objects == 1
              *    PLUGIN_EVENT.argNames.length == 1
              *    ...
              */
    36      PLUGIN_EVENT(new String[]{"plugin"}, PluginInfo.class);
    37      
    38      /** The names of the arguments for this meta type. */
    39      private String[] argNames;
    40      /** The classes of the arguments for this meta type. */
    41      private Class[] argTypes;
    42      
    43      /**
    44       * Creates a new instance of this meta-type.
    45       *
    46       * @param argNames The names of the meta-type's arguments
    47       * @param argTypes The types of the meta-type's arguments
    48       */
             /* 
    P/P       *  Method: void com.dmdirc.actions.metatypes.PluginEvents(String, int, String[], Class[])
              * 
              *  Postconditions:
              *    this.argNames == argNames
              *    init'ed(this.argNames)
              *    this.argTypes == argTypes
              *    init'ed(this.argTypes)
              */
    49      PluginEvents(final String[] argNames, final Class ... argTypes) {
    50          this.argNames = argNames;
    51          this.argTypes = argTypes;
    52      }
    53      
    54      /** {@inheritDoc} */
    55      @Override
    56      public int getArity() {
                 /* 
    P/P           *  Method: int getArity()
                  * 
                  *  Preconditions:
                  *    this.argNames != null
                  *    this.argNames.length <= 232-1
                  * 
                  *  Postconditions:
                  *    return_value == this.argNames.length
                  *    return_value >= 0
                  */
    57          return argNames.length;
    58      }
    59      
    60      /** {@inheritDoc} */
    61      @Override
    62      public Class[] getArgTypes() {
                 /* 
    P/P           *  Method: Class[] getArgTypes()
                  * 
                  *  Preconditions:
                  *    init'ed(this.argTypes)
                  * 
                  *  Postconditions:
                  *    return_value == this.argTypes
                  *    init'ed(return_value)
                  */
    63          return argTypes;
    64      }
    65      
    66      /** {@inheritDoc} */
    67      @Override
    68      public String[] getArgNames() {
                 /* 
    P/P           *  Method: String[] getArgNames()
                  * 
                  *  Preconditions:
                  *    init'ed(this.argNames)
                  * 
                  *  Postconditions:
                  *    return_value == this.argNames
                  *    init'ed(return_value)
                  */
    69          return argNames;
    70      }
    71      
    72      /** {@inheritDoc} */
    73      @Override
    74      public String getGroup() {
                 /* 
    P/P           *  Method: String getGroup()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"Plugin Events"
                  */
    75          return "Plugin Events";
    76      }    
    77      
    78  }