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

Class NickRejectedEvent

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.client.NickRejectedEvent

All Implemented Interfaces:

ClientLinked, ClientEvent, ServerMessageEvent

public class NickRejectedEvent
extends ServerMessageEventBase

The server has rejected your nick choice.

Constructor Summary

Constructors

Constructor and Description
NickRejectedEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull String attemptedNick, @NonNull String newNick) Constructs the event.

Method Summary

Modifier and Type	Method and Description
@NonNull String	getAttemptedNick() Gets the nickname which was attempted.
@NonNull String	getNewNick() Gets the new nickname to attempt, by default this is the previously attempted name (getAttemptedNick()) with a ` appended.
void	setNewNick(@NonNull String newNick) Sets the new nickname to attempt.
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.event.helper.ServerMessageEvent

getTag, getTag, getTags

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Constructor Detail

NickRejectedEvent

public NickRejectedEvent(@NonNull Client client,
                         @NonNull ServerMessage sourceMessage,
                         @NonNull String attemptedNick,
                         @NonNull String newNick)

Constructs the event.

Parameters:

client - the client

sourceMessage - source message

attemptedNick - the nick that failed

newNick - the new nick to attempt

Method Detail

getAttemptedNick

public @NonNull String getAttemptedNick()

Gets the nickname which was attempted.

Returns:

the attempted nick

getNewNick

public @NonNull String getNewNick()

Gets the new nickname to attempt, by default this is the previously attempted name (getAttemptedNick()) with a ` appended.

Returns:

new nick to attempt

setNewNick

public void setNewNick(@NonNull String newNick)

Sets the new nickname to attempt.

Parameters:

newNick - a new nickname

Throws:

IllegalArgumentException - if nickname is null, is same as the nickname this events reports has failed, contains invalid characters, or contains spaces

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