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

Class ClientNegotiationCompleteEvent

java.lang.Object

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

org.kitteh.irc.client.library.event.client.ClientNegotiationCompleteEvent

All Implemented Interfaces:

ClientLinked, ClientEvent

public class ClientNegotiationCompleteEvent
extends ClientEventBase

The Client has successfully completed negotiation with the server. At this time the client will begin to send queued messages which were not essential to negotiating the connection.

Constructor Summary

Constructors

Constructor and Description
ClientNegotiationCompleteEvent(@NonNull Client client, @NonNull Actor server, @NonNull ServerInfo serverInfo) Creates the event.

Method Summary

Modifier and Type	Method and Description
@NonNull Actor	getServer() Gets the server name to which the client has connected
@NonNull ServerInfo	getServerInfo() Gets information about the server to which the client is currently connected.
protected @NonNull 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

Constructor Detail

ClientNegotiationCompleteEvent

public ClientNegotiationCompleteEvent(@NonNull Client client,
                                      @NonNull Actor server,
                                      @NonNull ServerInfo serverInfo)

Creates the event.

Parameters:

client - client for which this is occurring

server - the server to which the client is connected

serverInfo - information about the server

Method Detail

getServer

public @NonNull Actor getServer()

Gets the server name to which the client has connected

Returns:

the server the client is connected to

getServerInfo

public @NonNull ServerInfo getServerInfo()

Gets information about the server to which the client is currently connected. As long as the client remains connected the information returned by this object will update according to information received from the server. Note that at the time of this event the server has not sent any information beyond its address and version.

Returns:

the server information object

See Also:

ServerInfo.getAddress(), ServerInfo.getVersion()

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ClientEventBase

Returns:

the partial toString generator