org.kitteh.irc.client.library.command

Class ChannelCommand<C extends ChannelCommand<C>>

java.lang.Object

org.kitteh.irc.client.library.command.Command<ChannelCommand<C>>

org.kitteh.irc.client.library.command.ChannelCommand<C>

All Implemented Interfaces:

ClientLinked

Direct Known Subclasses:

ChannelModeCommand, KickCommand, TopicCommand

public abstract class ChannelCommand<C extends ChannelCommand<C>>
extends Command<ChannelCommand<C>>

A command only executed on a channel.

Nested Class Summary

Nested classes/interfaces inherited from class org.kitteh.irc.client.library.command.Command

Command.Tags

Constructor Summary

Constructors

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

Method Summary

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

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

execute, getClient, sendCommandLine, sendCommandLine, tags, 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

public @NonNull String getChannel()

Gets the channel this command affects.

Returns:

channel relevant to this command

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command<ChannelCommand<C extends ChannelCommand<C>>>

Returns:

the partial toString generator