12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 |
- /*
- * Copyright (c) 2006-2013 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
- package com.dmdirc.parser.interfaces.callbacks;
-
- import com.dmdirc.parser.interfaces.ChannelClientInfo;
- import com.dmdirc.parser.interfaces.ChannelInfo;
- import com.dmdirc.parser.interfaces.FakableArgument;
- import com.dmdirc.parser.interfaces.FakableSource;
- import com.dmdirc.parser.interfaces.Parser;
- import com.dmdirc.parser.interfaces.SpecificCallback;
-
- import java.util.Date;
-
- /**
- * Called when a person is kicked.
- * cKickedByClient can be null if kicked by a server. sKickedByHost is the hostname of the person/server doing the kicking.
- */
- @SpecificCallback
- public interface ChannelKickListener extends CallbackInterface {
-
- /**
- * Called when a person is kicked.
- * cKickedByClient can be null if kicked by a server. sKickedByHost is the hostname of the person/server doing the kicking.
- *
- * @param parser Reference to the parser object that made the callback.
- * @param date The date/time at which the event occured
- * @param channel Channel where the kick took place
- * @param kickedClient ChannelClient that got kicked
- * @param client ChannelClient that did the kicking (may be null if server)
- * @param reason Reason for kick (may be "")
- * @param host Hostname of Kicker (or servername)
- * @see com.dmdirc.parser.irc.ProcessKick#callChannelKick
- */
- void onChannelKick(@FakableSource Parser parser,
- Date date,
- @FakableSource ChannelInfo channel,
- ChannelClientInfo kickedClient,
- @FakableArgument ChannelClientInfo client,
- String reason,
- @FakableSource String host);
- }
|