/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.ChannelCommand__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.commands;
    24  
    25  import com.dmdirc.Channel;
    26  import com.dmdirc.Server;
    27  import com.dmdirc.commandparser.CommandArguments;
    28  import com.dmdirc.commandparser.CommandInfo;
    29  import com.dmdirc.commandparser.CommandType;
    30  import com.dmdirc.ui.interfaces.InputWindow;
    31  
    32  /**
    33   * Represents a command which can be performed only in the context of a channel.
    34   * @author chris
    35   */
         /* 
    P/P   *  Method: void com.dmdirc.commandparser.commands.ChannelCommand()
          */
    36  public abstract class ChannelCommand extends Command implements CommandInfo {
    37      
    38      /**
    39       * Executes this command.
    40       *
    41       * @param origin The window in which the command was typed
    42       * @param server The server instance that this command is being executed on
    43       * @param channel The channel instance that this command is being executed on
    44       * @param isSilent Whether this command is silenced or not
    45       * @param args Arguments passed to this command
    46       * @since 0.6.3m1
    47       */
    48      public abstract void execute(InputWindow origin, Server server, Channel channel,
    49              boolean isSilent, CommandArguments args);
    50  
    51      /** {@inheritDoc} */
    52      @Override
    53      public CommandType getType() {
                 /* 
    P/P           *  Method: CommandType getType()
                  * 
                  *  Postconditions:
                  *    return_value == &com.dmdirc.commandparser.CommandType__static_init.new CommandType(CommandType__static_init#4)
                  */
    54          return CommandType.TYPE_CHANNEL;
    55      }
    56      
    57  }