f00f.net.irc.martyr.commands
Class TopicCommand

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

All Implemented Interfaces:

Command, InCommand, OutCommand

public class TopicCommand
extends AbstractCommand

Field Summary

static java.lang.String	IDENTIFIER_PRIMARY
static java.lang.String	IDENTIFIER_SECONDARY

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

attributes

Constructor Summary

TopicCommand()

TopicCommand(java.lang.String channel, java.lang.String topic)

Method Summary

java.lang.String	getChannel()
java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getTopic()
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.
void	selfRegister(CommandRegister commandRegister) Every command should know how to register itself (or not) with the command parsing engine.
boolean	updateClientState(ClientState state) By default, commands do not update the client state.

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

Methods inherited from class java.lang.Object

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

Field Detail

IDENTIFIER_PRIMARY

public static final java.lang.String IDENTIFIER_PRIMARY

See Also:

Constant Field Values

IDENTIFIER_SECONDARY

public static final java.lang.String IDENTIFIER_SECONDARY

See Also:

Constant Field Values

Constructor Detail

TopicCommand

public TopicCommand()

TopicCommand

public TopicCommand(java.lang.String channel,
                    java.lang.String topic)

Method Detail

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

selfRegister

public void selfRegister(CommandRegister commandRegister)

Description copied from class: AbstractInCommand

Every command should know how to register itself (or not) with the command parsing engine. If a command is available under mutiple identifiers, then this method can be overridden and the addCommand method can be called multiple times.

Specified by:

selfRegister in interface InCommand

Overrides:

selfRegister in class AbstractInCommand

Parameters:

commandRegister - Command register we want to register with

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

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

getTopic

public java.lang.String getTopic()

getChannel

public java.lang.String getChannel()

updateClientState

public boolean updateClientState(ClientState state)

Description copied from class: AbstractInCommand

By default, commands do not update the client state.

Specified by:

updateClientState in interface InCommand

Overrides:

updateClientState in class AbstractInCommand

Parameters:

state - Client state to be updated

Returns:

True or false if changes were made