f00f.net.irc.martyr.commands
Class WelcomeCommand

java.lang.Object
  |
  +--f00f.net.irc.martyr.commands.GenericCommand
        |
        +--f00f.net.irc.martyr.commands.WelcomeCommand

All Implemented Interfaces:

Command

public class WelcomeCommand

extends GenericCommand

Defines the commands that a server issues to welcome us. These are identified with 001, 002... etc. These commands are only received after we register, unlike the NOTICE command.

Constructor Summary

WelcomeCommand()
Factory

WelcomeCommand(java.lang.String notice)

Method Summary

java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getNotice()
Command	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.
void	selfRegister(CommandRegister commandRegister) Every command should know how to register itself (or not) with the command parsing engine.

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

getIntParameter, getParameter, getSourceString, getState, render, setSourceString, updateClientState

Methods inherited from class java.lang.Object

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

Constructor Detail

WelcomeCommand

public WelcomeCommand()

Factory

WelcomeCommand

public WelcomeCommand(java.lang.String notice)

Method Detail

parse

public Command 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. Should return null if it cannot form the command object.

Overrides:

parse in class GenericCommand

getIrcIdentifier

public java.lang.String getIrcIdentifier()

Returns the string IRC uses to identify this command. Examples: NICK, PING, KILL, 332. In our case, there is no one thing.

Overrides:

getIrcIdentifier in class GenericCommand

selfRegister

public void selfRegister(CommandRegister commandRegister)

Description copied from class: GenericCommand

Every command should know how to register itself (or not) with the command parsing engine. If a command is available under mutiple identifiers, then this method can be overridden and the addCommand method can be called multiple times.

Overrides:

selfRegister in class GenericCommand

renderParams

public java.lang.String renderParams()

Renders the parameters of this command.

Overrides:

renderParams in class GenericCommand

getNotice

public java.lang.String getNotice()