/* 
    P/P   *  Method: com.dmdirc.actions.interfaces.ActionMetaType__static_init
          */
     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.interfaces;
    24  
    25  /**
    26   * Encapsulates the methods that all action types are required to implement.
    27   * @author chris
    28   */
    29  public interface ActionMetaType {
    30      
    31      /**
    32       * Retrieves the arity of this type.
    33       * @return The arity of this action type
    34       */
    35      int getArity();
    36      
    37      /**
    38       * Retrieves the type of arguments that actions of this type should expect.
    39       * @return The type of arguments expected
    40       */
    41      Class[] getArgTypes();
    42      
    43      /**
    44       * Retrieves the names of the arguments that actions of this type should
    45       * expect.
    46       * @return The names of the expected arguments
    47       */
    48      String[] getArgNames();
    49      
    50      /**
    51       * Retrieves the name of a logical group for this meta-type to be put into.
    52       * 
    53       * @return The meta-type's group name
    54       */
    55      String getGroup();
    56      
    57  }