/* 
    P/P   *  Method: com.dmdirc.commandparser.CommandInfo__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.commandparser;
    24  
    25  /**
    26   * Describes a command.
    27   * 
    28   * @author chris
    29   */
    30  public interface CommandInfo {
    31            
    32      /**
    33       * Returns this command's name.
    34       *
    35       * @return The name of this command
    36       */
    37      String getName();
    38      
    39      /**
    40       * Returns whether or not this command should be shown in help messages.
    41       *
    42       * @return True iff the command should be shown, false otherwise
    43       */
    44      boolean showInHelp();
    45      
    46      /**
    47       * Returns a string representing the help message for this command.
    48       *
    49       * @return the help message for this command
    50       */
    51      String getHelp();
    52      
    53      /**
    54       * Retrieves the type of this command.
    55       *
    56       * @return This command's type
    57       */
    58      CommandType getType();
    59  
    60  }