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

Class ChannelEventBase

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.ChannelEventBase

All Implemented Interfaces:

ClientLinked, ChannelEvent, ClientEvent, ServerMessageEvent

Direct Known Subclasses:

ChannelTopicEvent, ClearChatEvent, RoomStateEvent, UserNoticeEvent, UserStateEvent

public abstract class ChannelEventBase
extends ServerMessageEventBase
implements ChannelEvent

Abstract base class for events involving a Channel. Use the helper events if you want to listen to such events.

See Also:

ChannelEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelEventBase(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull Channel channel) Constructs the event.

Method Summary

Modifier and Type	Method and Description
@NonNull Channel	getChannel() Gets the Channel involved in this event.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getSource

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.element.ClientLinked

getClient

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

getTag, getTag, getTags

Constructor Detail

ChannelEventBase

protected ChannelEventBase(@NonNull Client client,
                           @NonNull ServerMessage sourceMessage,
                           @NonNull Channel channel)

Constructs the event.

Parameters:

client - the client

sourceMessage - source message

channel - the channel

Method Detail

getChannel

public final @NonNull Channel getChannel()

Description copied from interface: ChannelEvent

Gets the Channel involved in this event.

Specified by:

getChannel in interface ChannelEvent

Returns:

the channel

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ServerMessageEventBase

Returns:

the partial toString generator