f00f.net.irc.martyr.replies
Class TopicInfoReply

java.lang.Object
  extended by f00f.net.irc.martyr.commands.AbstractInCommand
      extended by f00f.net.irc.martyr.replies.GenericReply
          extended by f00f.net.irc.martyr.replies.TopicInfoReply
All Implemented Interfaces:
Command, InCommand

public class TopicInfoReply
extends GenericReply

Contains info about the topic, who set it and when.


Field Summary
 
Fields inherited from class f00f.net.irc.martyr.commands.AbstractInCommand
attributes
 
Constructor Summary
TopicInfoReply()
          For use as a factory.
TopicInfoReply(java.lang.String channelName, java.util.Date date, java.lang.String author)
           
 
Method Summary
 java.lang.String getChannel()
           
 java.lang.String getIrcIdentifier()
          Returns the string IRC uses to identify this command.
 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.
 boolean updateClientState(ClientState state)
          By default, commands do not update the client state.
 
Methods inherited from class f00f.net.irc.martyr.commands.AbstractInCommand
getAttribute, getAttributeKeys, getIntParameter, getParameter, getSourceString, getState, selfRegister, setAttribute, setSourceString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TopicInfoReply

public TopicInfoReply()
For use as a factory.


TopicInfoReply

public TopicInfoReply(java.lang.String channelName,
                      java.util.Date date,
                      java.lang.String author)
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

getChannel

public java.lang.String getChannel()

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

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


Copyright © 2000-2007 Ben Damm, Daniel Henninger, et al.