/* 
    P/P   *  Method: com.dmdirc.parser.irc.callbacks.interfaces.IChannelKick__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.parser.irc.callbacks.interfaces;
    24  
    25  import com.dmdirc.parser.irc.ChannelClientInfo;
    26  import com.dmdirc.parser.irc.ChannelInfo;
    27  import com.dmdirc.parser.irc.IRCParser;
    28  import com.dmdirc.parser.irc.callbacks.FakableArgument;
    29  import com.dmdirc.parser.irc.callbacks.FakableSource;
    30  import com.dmdirc.parser.irc.callbacks.SpecificCallback;
    31  
    32  /**
    33   * Called when a person is kicked.
    34   * cKickedByClient can be null if kicked by a server. sKickedByHost is the hostname of the person/server doing the kicking.
    35   */
    36  @SpecificCallback
    37  public interface IChannelKick extends ICallbackInterface {
    38  	/**
    39  	 * Called when a person is kicked.
    40  	 * cKickedByClient can be null if kicked by a server. sKickedByHost is the hostname of the person/server doing the kicking.
    41  	 *
    42  	 * @param tParser Reference to the parser object that made the callback.
    43  	 * @param cChannel Channel where the kick took place
    44  	 * @param cKickedClient ChannelClient that got kicked
    45  	 * @param cKickedByClient ChannelClient that did the kicking (may be null if server)
    46  	 * @param sReason Reason for kick (may be "")
    47  	 * @param sKickedByHost Hostname of Kicker (or servername)
    48  	 * @see com.dmdirc.parser.irc.ProcessKick#callChannelKick
    49  	 */
    50  	void onChannelKick(@FakableSource IRCParser tParser,
    51              @FakableSource ChannelInfo cChannel,
    52              ChannelClientInfo cKickedClient,
    53              @FakableArgument ChannelClientInfo cKickedByClient,
    54              String sReason,
    55              @FakableSource String sKickedByHost);
    56  }