f00f.net.irc.martyr.commands
Class InviteCommand

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

All Implemented Interfaces:

Command, InCommand, OutCommand

public class InviteCommand
extends AbstractCommand

Author:

Morgan Christiansson

Field Summary

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

attributes

Constructor Summary

InviteCommand()
For use as a factory

InviteCommand(FullNick nick, java.lang.String channel)

InviteCommand(java.lang.String nick, java.lang.String channel)

Method Summary

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

InviteCommand

public InviteCommand()

For use as a factory

InviteCommand

public InviteCommand(java.lang.String nick,
                     java.lang.String channel)

InviteCommand

public InviteCommand(FullNick nick,
                     java.lang.String channel)

Method Detail

parse

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

Description copied from class: AbstractInCommand

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

Description copied from interface: Command

Returns the string IRC uses to identify this command. Examples: NICK, PING, KILL, 332. Not strictly required for OutCommands as the irc identifier is expected to be part of the reder() result.

Returns:

The IRC identifier string

renderParams

public java.lang.String renderParams()

Description copied from class: AbstractCommand

Renders the parameters of this command.

Specified by:

renderParams in class AbstractCommand

Returns:

String of rendered parameters

getChannel

public java.lang.String getChannel()

Returns:

The channel invited to.

getNick

public java.lang.String getNick()

Returns:

The nick sending the invite.

getUser

public FullNick getUser()

Returns:

The user the invite is sent to.