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

Class ServerMessageEventBase

java.lang.Object

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

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

All Implemented Interfaces:

ClientLinked, ClientEvent, ServerMessageEvent

Direct Known Subclasses:

ActorEventBase, CapabilitiesListEvent, CapabilityNegotiationResponseEventBase, ChannelEventBase, ClientAwayStatusChangeEvent, ClientReceiveMotdEvent, GlobalUserStateEvent, MonitoredNickEventBase, MonitoredNickListEvent, MonitoredNickListFullEvent, NickRejectedEvent

public abstract class ServerMessageEventBase
extends ClientEventBase
implements ServerMessageEvent

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

See Also:

ServerMessageEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerMessageEventBase(Client client, List<ServerMessage> originalMessages) Constructs the event.

Method Summary

Modifier and Type	Method and Description
List<ServerMessage>	getOriginalMessages() Gets the original messages that caused this event.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

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

Constructor Detail

ServerMessageEventBase

protected ServerMessageEventBase(@Nonnull
                                 Client client,
                                 @Nonnull
                                 List<ServerMessage> originalMessages)

Constructs the event.

Parameters:

client - the client

originalMessages - original messages

Method Detail

getOriginalMessages

@Nonnull
public List<ServerMessage> getOriginalMessages()

Description copied from interface: ServerMessageEvent

Gets the original messages that caused this event.

Specified by:

getOriginalMessages in interface ServerMessageEvent

Returns:

at least one message that lead to this event

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ClientEventBase

Returns:

the partial toString generator