f00f.net.irc.martyr.commands
Class ListCommand

java.lang.Object
  f00f.net.irc.martyr.commands.ListCommand

All Implemented Interfaces:

Command, OutCommand

public class ListCommand
extends java.lang.Object
implements OutCommand

Defines the LIST command, which is used to get the topic and member count of certain channels, or all of them.

Author:

Daniel Henninger

Constructor Summary

ListCommand()
No parameter passed to the LIST command represents a request for all channels.

ListCommand(java.util.List<java.lang.String> channels)
Request information of multiple channels.

ListCommand(java.lang.String channel)
Request information about a single channel.

Method Summary

java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	render() Forms a string appropriate to send to the server, if required.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCommand

public ListCommand()

No parameter passed to the LIST command represents a request for all channels.

ListCommand

public ListCommand(java.lang.String channel)

Request information about a single channel.

Parameters:

channel - Channel you want to request the topic and member count of.

ListCommand

public ListCommand(java.util.List<java.lang.String> channels)

Request information of multiple channels.

Parameters:

channels - List of channels you want to retrieve the topic and member count of.

Method Detail

render

public java.lang.String render()

Description copied from interface: OutCommand

Forms a string appropriate to send to the server, if required. Some commands will have no such string, as they are received and not sent. The string returned is sent to the server verbatim.

Specified by:

render in interface OutCommand

Returns:

Rendered string

See Also:

OutCommand.render()

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

Returns:

The IRC identifier string

See Also:

Command.getIrcIdentifier()