/* 
    P/P   *  Method: com.dmdirc.actions.interfaces.ActionComponent__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   * The ActionComponent interface describes the methods that action components
    27   * are required to implement. Components are objects that allow the user to
    28   * pull a specific piece of information from a certain type of argument.
    29   * @author chris
    30   */
    31  public interface ActionComponent {
    32      
    33      /**
    34       * Retrieves the component of the specified argument that this enum
    35       * represents.
    36       * @param argument The object to retrieve the component from
    37       * @return The relevant component of the object
    38       */    
    39      Object get(Object argument);
    40      
    41      /**
    42       * Retrieves the type of class that this component applies to.
    43       * @return The Class that this component can be applied to
    44       */
    45      Class appliesTo();
    46      
    47      /**
    48       * Retrieves the type of this component.
    49       * @return The Class of this component.
    50       */
    51      Class getType();
    52      
    53      /**
    54       * Retrives a friendly name for this component.
    55       * @return This component's name
    56       */
    57      String getName();
    58      
    59  }