f00f.net.irc.martyr.commands
Class NickCommand

java.lang.Object
  extended by f00f.net.irc.martyr.commands.AbstractInCommand
      extended by f00f.net.irc.martyr.commands.AbstractCommand
          extended by f00f.net.irc.martyr.commands.NickCommand
All Implemented Interfaces:
Command, InCommand, OutCommand

public class NickCommand
extends AbstractCommand

Defines NICK command.


Field Summary
 
Fields inherited from class f00f.net.irc.martyr.commands.AbstractInCommand
attributes
 
Constructor Summary
NickCommand()
          For use as a factory
NickCommand(FullNick oldNick, FullNick newNick)
           
NickCommand(java.lang.String newNick)
           
 
Method Summary
 java.lang.String getIrcIdentifier()
          Returns the string IRC uses to identify this command.
 java.lang.String getNick()
           
 java.lang.String getOldNick()
           
 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.
 java.lang.String renderParams()
          Renders the parameters of this command.
 boolean updateClientState(ClientState state)
          By default, commands do not update the client state.
 
Methods inherited from class f00f.net.irc.martyr.commands.AbstractCommand
render
 
Methods inherited from class f00f.net.irc.martyr.commands.AbstractInCommand
getAttribute, getAttributeKeys, getIntParameter, getParameter, getSourceString, getState, selfRegister, setAttribute, setSourceString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NickCommand

public NickCommand()
For use as a factory


NickCommand

public NickCommand(FullNick oldNick,
                   FullNick newNick)

NickCommand

public NickCommand(java.lang.String newNick)
Method Detail

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

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

renderParams

public java.lang.String renderParams()
Description copied from class: AbstractCommand
Renders the parameters of this command.

Specified by:
renderParams in class AbstractCommand
Returns:
String of rendered parameters

getNick

public java.lang.String getNick()

getOldNick

public java.lang.String getOldNick()

updateClientState

public boolean updateClientState(ClientState state)
Description copied from class: AbstractInCommand
By default, commands do not update the client state.

Specified by:
updateClientState in interface InCommand
Overrides:
updateClientState in class AbstractInCommand
Parameters:
state - Client state to be updated
Returns:
True or false if changes were made


Copyright © 2000-2007 Ben Damm, Daniel Henninger, et al.