f00f.net.irc.martyr.commands
Class PingCommand

java.lang.Object
  f00f.net.irc.martyr.commands.AbstractInCommand
      f00f.net.irc.martyr.commands.AbstractCommand
          f00f.net.irc.martyr.commands.PingCommand

All Implemented Interfaces:

Command, InCommand, OutCommand

Direct Known Subclasses:

PongCommand

public class PingCommand
extends AbstractCommand

Defines the PING command. At this point, PINGs only come in from the server, so all we need to do is capture the parameters.

Field Summary

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

attributes

Constructor Summary

PingCommand()
Factory

PingCommand(java.lang.String source)

Method Summary

java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getPingSource()
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.
java.lang.String	renderParams() Renders the parameters of this command.

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, selfRegister, setAttribute, setSourceString, updateClientState

Methods inherited from class java.lang.Object

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

Constructor Detail

PingCommand

public PingCommand()

Factory

PingCommand

public PingCommand(java.lang.String source)

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

parse

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

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

Returns:

The IRC identifier string

renderParams

public java.lang.String renderParams()

Renders the parameters of this command.

Specified by:

renderParams in class AbstractCommand

Returns:

String of rendered parameters

getPingSource

public java.lang.String getPingSource()