f00f.net.irc.martyr.errors
Class NickInUseError

java.lang.Object
  f00f.net.irc.martyr.commands.AbstractInCommand
      f00f.net.irc.martyr.errors.GenericError
          f00f.net.irc.martyr.errors.NickInUseError

All Implemented Interfaces:

Command, InCommand

public class NickInUseError
extends GenericError

Code: 433 ERR_ERRONEUSNICKNAME <nick> :Nickname is already in use Returned when a NICK message is processed that result in an attempt to change to a currently existing nickname. TODO: Should we rename this to NicknameInUseError for consistency with rest of errors/matching RFC?

Field Summary

Fields inherited from class f00f.net.irc.martyr.commands.AbstractInCommand

attributes

Constructor Summary

NickInUseError()

NickInUseError(FullNick nick, java.lang.String errorMessage)

Method Summary

java.lang.String	getErrorMessage()
java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
FullNick	getNick()
State	getState() Some commands, when received by the server, can only occur in one state.
InCommand	parse(java.lang.String prefix, java.lang.String identifier, java.lang.String params) Parses a string and produces a formed command object, if it can.

Methods inherited from class f00f.net.irc.martyr.commands.AbstractInCommand

getAttribute, getAttributeKeys, getIntParameter, getParameter, getSourceString, selfRegister, setAttribute, setSourceString, updateClientState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NickInUseError

public NickInUseError()

NickInUseError

public NickInUseError(FullNick nick,
                      java.lang.String errorMessage)

Method Detail

getState

public State getState()

Description copied from class: AbstractInCommand

Some commands, when received by the server, can only occur in one state. Thus, when this command is received, the protocol should assume that it is that state. A command can use the 'unknown' state to indicate it can be received in any state (for example, ping). Most commands will occur in the REGISTERED state, so for a few exeptions, commands can leave this alone.

Specified by:

getState in interface InCommand

Overrides:

getState in class AbstractInCommand

Returns:

State associated with command

getIrcIdentifier

public java.lang.String getIrcIdentifier()

Description copied from interface: Command

Returns the string IRC uses to identify this command. Examples: NICK, PING, KILL, 332. Not strictly required for OutCommands as the irc identifier is expected to be part of the reder() result.

Returns:

The IRC identifier string

parse

public InCommand parse(java.lang.String prefix,
                       java.lang.String identifier,
                       java.lang.String params)

Description copied from class: AbstractInCommand

Parses a string and produces a formed command object, if it can. Should return null if it cannot form the command object.

Specified by:

parse in interface InCommand

Specified by:

parse in class AbstractInCommand

Parameters:

prefix - Prefix of the command

identifier - ID of the command

params - Parameters of the command

Returns:

InCommand instance for parsed command

getNick

public FullNick getNick()

Returns:

The nick in use.

getErrorMessage

public java.lang.String getErrorMessage()