f00f.net.irc.martyr.commands
Class NoticeCommand

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

All Implemented Interfaces:

Command, InCommand, OutCommand

Direct Known Subclasses:

CtcpNotice

public class NoticeCommand
extends AbstractCommand

Defines the NOTICE command.

Field Summary

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

attributes

Constructor Summary

NoticeCommand()
Factory

NoticeCommand(FullNick dest, java.lang.String notice)

NoticeCommand(FullNick source, java.lang.String dest, java.lang.String notice)

NoticeCommand(java.lang.String notice)

NoticeCommand(java.lang.String dest, java.lang.String notice)

Method Summary

java.lang.String	getDest()
FullNick	getFrom()
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.
boolean	isPrivateToUs(ClientState state) Returns true if the message is both private and for us.
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

NoticeCommand

public NoticeCommand()

Factory

NoticeCommand

public NoticeCommand(java.lang.String notice)

NoticeCommand

public NoticeCommand(java.lang.String dest,
                     java.lang.String notice)

NoticeCommand

public NoticeCommand(FullNick dest,
                     java.lang.String notice)

NoticeCommand

public NoticeCommand(FullNick source,
                     java.lang.String dest,
                     java.lang.String notice)

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

getFrom

public FullNick getFrom()

getDest

public java.lang.String getDest()

getNotice

public java.lang.String getNotice()

isPrivateToUs

public boolean isPrivateToUs(ClientState state)

Returns true if the message is both private and for us.

Parameters:

state - Client state to compare with

Returns:

True or false if this is a private message to us