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

Class ClientReceiveServerMessageEventBase

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<Actor>

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

All Implemented Interfaces:

ClientLinked, ActorEvent<Actor>, ClientEvent, ClientReceiveServerMessageEvent, ServerMessageEvent

Direct Known Subclasses:

ClientReceiveCommandEvent, ClientReceiveNumericEvent

public class ClientReceiveServerMessageEventBase
extends ActorEventBase<Actor>
implements ClientReceiveServerMessageEvent

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

Constructor Summary

Constructors

Constructor and Description
ClientReceiveServerMessageEventBase(Client client, ServerMessage serverMessage, Actor server, String command, List<String> parameters) Constructs the event.

Method Summary

Modifier and Type	Method and Description
String	getCommand() Gets the command sent.
List<MessageTag>	getMessageTags() Gets the message tags.
String	getOriginalMessage() Gets the original message received by the server.
List<String>	getParameters() Gets the subsequent arguments after the command.
ServerMessage	getServerMessage() Gets the server message received.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getActor

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

ClientReceiveServerMessageEventBase

public ClientReceiveServerMessageEventBase(@Nonnull
                                           Client client,
                                           @Nonnull
                                           ServerMessage serverMessage,
                                           @Nonnull
                                           Actor server,
                                           @Nonnull
                                           String command,
                                           @Nonnull
                                           List<String> parameters)

Constructs the event.

Parameters:

client - client

serverMessage - server message

server - server

command - command

parameters - parameters

Method Detail

getParameters

@Nonnull
public List<String> getParameters()

Gets the subsequent arguments after the command.

Specified by:

getParameters in interface ClientReceiveServerMessageEvent

Returns:

arguments

getCommand

@Nonnull
public String getCommand()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the command sent.

Specified by:

getCommand in interface ClientReceiveServerMessageEvent

Returns:

command, upper-case

getMessageTags

@Nonnull
public List<MessageTag> getMessageTags()

Gets the message tags.

Specified by:

getMessageTags in interface ClientReceiveServerMessageEvent

Returns:

message tags

getOriginalMessage

@Nonnull
public String getOriginalMessage()

Gets the original message received by the server.

Specified by:

getOriginalMessage in interface ClientReceiveServerMessageEvent

Returns:

unprocessed, original message

getServerMessage

@Nonnull
public ServerMessage getServerMessage()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the server message received.

Specified by:

getServerMessage in interface ClientReceiveServerMessageEvent

Returns:

the server message

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorEventBase<Actor>

Returns:

the partial toString generator