org.kitteh.irc.client.library.event.channel

Class ChannelKickEvent

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

org.kitteh.irc.client.library.event.abstractbase.ActorEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorChannelEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorChannelMessageEventBase<Actor>

org.kitteh.irc.client.library.event.channel.ChannelKickEvent

All Implemented Interfaces:

ClientLinked, ActorEvent<Actor>, ChannelEvent, ChannelUserListChangeEvent, ClientEvent, MessageEvent, ServerMessageEvent

Direct Known Subclasses:

UnexpectedChannelLeaveViaKickEvent

public class ChannelKickEvent
extends ActorChannelMessageEventBase<Actor>
implements ChannelUserListChangeEvent

A User has kicked another User!

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.event.helper.ChannelUserListChangeEvent

ChannelUserListChangeEvent.Change

Constructor Summary

Constructors

Constructor and Description
ChannelKickEvent(Client client, List<ServerMessage> originalMessages, Channel channel, Actor actor, User target, String message) Creates the event.

Method Summary

Modifier and Type	Method and Description
Optional<Channel>	getAffectedChannel() Gets the channel affected or empty if affecting all channels the user is present in.
ChannelUserListChangeEvent.Change	getChange() Gets the type of change occurring.
User	getTarget() Gets the kicked user.
User	getUser() Gets the current user affected.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorChannelMessageEventBase

getMessage

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorChannelEventBase

getChannel

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorEventBase

getActor

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

getOriginalMessages

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getOriginalMessages

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Constructor Detail

ChannelKickEvent

public ChannelKickEvent(@Nonnull
                        Client client,
                        @Nonnull
                        List<ServerMessage> originalMessages,
                        @Nonnull
                        Channel channel,
                        @Nonnull
                        Actor actor,
                        @Nonnull
                        User target,
                        @Nonnull
                        String message)

Creates the event.

Parameters:

client - client for which this is occurring

originalMessages - original messages

channel - channel being left

actor - actor kicking the targeted user

target - targeted user

message - message the user left

Method Detail

getAffectedChannel

@Nonnull
public Optional<Channel> getAffectedChannel()

Description copied from interface: ChannelUserListChangeEvent

Gets the channel affected or empty if affecting all channels the user is present in.

Specified by:

getAffectedChannel in interface ChannelUserListChangeEvent

Returns:

channel or empty if all channels affected

getChange

@Nonnull
public ChannelUserListChangeEvent.Change getChange()

Description copied from interface: ChannelUserListChangeEvent

Gets the type of change occurring.

Specified by:

getChange in interface ChannelUserListChangeEvent

Returns:

type of change

getTarget

@Nonnull
public User getTarget()

Gets the kicked user.

Returns:

the nickname of the kicked user

getUser

@Nonnull
public User getUser()

Description copied from interface: ChannelUserListChangeEvent

Gets the current user affected.

Specified by:

getUser in interface ChannelUserListChangeEvent

Returns:

user

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorChannelMessageEventBase<Actor>

Returns:

the partial toString generator