org.kitteh.irc.client.library.command

Class ChannelCommand

java.lang.Object

org.kitteh.irc.client.library.command.Command

org.kitteh.irc.client.library.command.ChannelCommand

All Implemented Interfaces:

ClientLinked

Direct Known Subclasses:

ChannelModeCommand, KickCommand, TopicCommand

public abstract class ChannelCommand
extends Command

A command only executed on a channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelCommand(Client client, String channel) Constructs a command for a given channel.

Method Summary

Modifier and Type	Method and Description
String	getChannel() Gets the channel this command affects.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.command.Command

execute, getClient, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelCommand

protected ChannelCommand(@Nonnull
                         Client client,
                         @Nonnull
                         String channel)

Constructs a command for a given channel.

Parameters:

client - the client on which this command is executing

channel - channel targeted

Throws:

IllegalArgumentException - if null parameters

Method Detail

getChannel

@Nonnull
public String getChannel()

Gets the channel this command affects.

Returns:

channel relevant to this command

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command

Returns:

the partial toString generator