f00f.net.irc.martyr.commands
Class MessageCommand

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

All Implemented Interfaces:

Command, InCommand, OutCommand

Direct Known Subclasses:

CtcpMessage

public class MessageCommand
extends AbstractCommand

Defines the PRIVMSG command. Messages can be sent to groups or to users.

Field Summary

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

attributes

Constructor Summary

MessageCommand()
Factory

MessageCommand(FullNick dest, java.lang.String message)
Used to send a message.

MessageCommand(FullNick source, java.lang.String dest, java.lang.String message)

MessageCommand(java.lang.String dest, java.lang.String message)
Used to send a message.

Method Summary

java.lang.String	getDest()
java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getMessage()
FullNick	getSource()
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, getState, selfRegister, setAttribute, setSourceString, updateClientState

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageCommand

public MessageCommand()

Factory

MessageCommand

public MessageCommand(java.lang.String dest,
                      java.lang.String message)

Used to send a message.

Parameters:

dest - Target for message

message - Message to be sent

MessageCommand

public MessageCommand(FullNick dest,
                      java.lang.String message)

Used to send a message.

Parameters:

dest - Target for message

message - Message to be sent

MessageCommand

public MessageCommand(FullNick source,
                      java.lang.String dest,
                      java.lang.String message)

Method Detail

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

getSource

public FullNick getSource()

getDest

public java.lang.String getDest()

getMessage

public java.lang.String getMessage()

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