f00f.net.irc.martyr.replies
Class WhoisChannelsReply

java.lang.Object
  f00f.net.irc.martyr.commands.AbstractInCommand
      f00f.net.irc.martyr.replies.GenericReply
          f00f.net.irc.martyr.replies.AbstractWhoisReply
              f00f.net.irc.martyr.replies.WhoisChannelsReply

All Implemented Interfaces:

Command, InCommand

public class WhoisChannelsReply
extends AbstractWhoisReply

Field Summary

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

attributes

Constructor Summary

WhoisChannelsReply()
Factory constructor.

WhoisChannelsReply(java.lang.String params)

Method Summary

java.lang.String	getChannels()
java.util.Set<java.lang.String>	getChannelSet()
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.
protected void	parseParams(ParameterIterator pi) Parse the parameters, but the target param has already been stripped off.

Methods inherited from class f00f.net.irc.martyr.replies.AbstractWhoisReply

getParams, getTarget

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

WhoisChannelsReply

public WhoisChannelsReply()

Factory constructor.

WhoisChannelsReply

public WhoisChannelsReply(java.lang.String params)

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.

Specified by:

getIrcIdentifier in interface Command

Specified by:

getIrcIdentifier in class AbstractWhoisReply

Returns:

The IRC identifier string

getChannels

public java.lang.String getChannels()

Returns:

a space-delimited list of channels

getChannelSet

public java.util.Set<java.lang.String> getChannelSet()

Returns:

a set of Strings of channels

parseParams

protected void parseParams(ParameterIterator pi)

Description copied from class: AbstractWhoisReply

Parse the parameters, but the target param has already been stripped off.

Specified by:

parseParams in class AbstractWhoisReply

Parameters:

pi - Parameter iterator that will parse the parameters

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