f00f.net.irc.martyr.commands
Class QuitCommand

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

All Implemented Interfaces:

Command

public class QuitCommand

extends GenericCommand

Defines QUIT command. The QUIT command asks the irc server to disconnect us, and we can optionally give a reason. The QUIT command is also received by us if someone on a channel we are on quits.

What should be done to signal to the framework that the disconnection that should come from the server is legit, and we shouldn't try to re-connecet? For now it will be assumed that the user of the framework will signal all the appropriate classes that a legit disconnection will happen (ie AutoRegister which will try to re-connect otherwise).

Constructor Summary

QuitCommand()
For use as a factory

QuitCommand(FullNick user, java.lang.String reason)
For use as an incoming command.

QuitCommand(java.lang.String reason)
For use as an outgoing command.

Method Summary

java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getReason()
FullNick	getUser()
boolean	isOurQuit(ClientState state) Returns true if we are the ones quitting.
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.
boolean	updateClientState(ClientState state) If we are quitting, we won't be worrying about our client state.

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

getIntParameter, getParameter, getSourceString, getState, render, selfRegister, setSourceString

Methods inherited from class java.lang.Object

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

Constructor Detail

QuitCommand

public QuitCommand()

For use as a factory

QuitCommand

public QuitCommand(FullNick user,
                   java.lang.String reason)

For use as an incoming command.

QuitCommand

public QuitCommand(java.lang.String reason)

For use as an outgoing command.

Method Detail

parse

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

Description copied from class: GenericCommand

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()

Description copied from class: GenericCommand

Returns the string IRC uses to identify this command. Examples: NICK, PING, KILL, 332

Overrides:

getIrcIdentifier in class GenericCommand

renderParams

public java.lang.String renderParams()

Description copied from class: GenericCommand

Renders the parameters of this command.

Overrides:

renderParams in class GenericCommand

getReason

public java.lang.String getReason()

getUser

public FullNick getUser()

isOurQuit

public boolean isOurQuit(ClientState state)

Returns true if we are the ones quitting.

updateClientState

public boolean updateClientState(ClientState state)

If we are quitting, we won't be worrying about our client state. If someone else is leaving, then remove them from all the groups they are in.

Overrides:

updateClientState in class GenericCommand