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(@NonNull Client client, @NonNull ServerMessage serverMessage, @NonNull Actor server, @NonNull String command, @NonNull List<String> parameters) Constructs the event.

Method Summary

Modifier and Type	Method and Description
@NonNull String	getCommand() Gets the command sent.
@NonNull List<MessageTag>	getMessageTags() Gets the message tags.
@NonNull List<String>	getParameters() Gets the subsequent parameters after the command.
@NonNull String	getRawMessage() Gets the unprocessed message received by the server.
@NonNull ServerMessage	getServerMessage() Gets the server message received.
protected @NonNull 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

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

getActor

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

getSource, getTag, getTag, getTags

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

public @NonNull List<String> getParameters()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the subsequent parameters after the command.

Specified by:

getParameters in interface ClientReceiveServerMessageEvent

Returns:

arguments

getCommand

public @NonNull String getCommand()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the command sent.

Specified by:

getCommand in interface ClientReceiveServerMessageEvent

Returns:

command, upper-case

getMessageTags

public @NonNull List<MessageTag> getMessageTags()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the message tags.

Specified by:

getMessageTags in interface ClientReceiveServerMessageEvent

Returns:

message tags

getRawMessage

public @NonNull String getRawMessage()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the unprocessed message received by the server.

Specified by:

getRawMessage in interface ClientReceiveServerMessageEvent

Returns:

unprocessed message

getServerMessage

public @NonNull ServerMessage getServerMessage()

Description copied from interface: ClientReceiveServerMessageEvent

Gets the server message received.

Specified by:

getServerMessage in interface ClientReceiveServerMessageEvent

Returns:

the server message

toStringer

protected @NonNull 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