f00f.net.irc.martyr.commands
Class NoticeCommand

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

All Implemented Interfaces:

Command, InCommand, OutCommand

public class NoticeCommand

extends GenericCommand

Defines the NOTICE command.

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

attributes

Constructor Summary

NoticeCommand()
Factory

NoticeCommand(java.lang.String notice)

Method Summary

java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getNotice()
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.GenericCommand

render

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

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

NoticeCommand

public NoticeCommand()

Factory

NoticeCommand

public NoticeCommand(java.lang.String notice)

Method Detail

getState

public State getState()

Description copied from class: GenericInCommand

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.

Overrides:

getState in class GenericInCommand

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.

Overrides:

parse in class GenericInCommand

getIrcIdentifier

public java.lang.String getIrcIdentifier()

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

renderParams

public java.lang.String renderParams()

Renders the parameters of this command.

Overrides:

renderParams in class GenericCommand

getNotice

public java.lang.String getNotice()