org.kitteh.irc.client.library.command

Class TopicCommand

java.lang.Object

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

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

org.kitteh.irc.client.library.command.TopicCommand

All Implemented Interfaces:

ClientLinked

public class TopicCommand
extends ChannelCommand<TopicCommand>

TOPICal command support.

Nested Class Summary

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

Command.Tags

Constructor Summary

Constructors

Constructor and Description
TopicCommand(@NonNull Client client, @NonNull String channel) Constructs a TOPIC command for a given channel.

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the command.
@NonNull TopicCommand	query() Sets this command to query the channel's current topic.
@NonNull TopicCommand	topic(@Nullable String topic) Sets the topic.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getChannel

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

getClient, sendCommandLine, sendCommandLine, tags, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicCommand

public TopicCommand(@NonNull Client client,
                    @NonNull String channel)

Constructs a TOPIC 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

topic

public @NonNull TopicCommand topic(@Nullable String topic)

Sets the topic.

Parameters:

topic - new topic or null to query the current topic

Returns:

this TopicCommand

Throws:

IllegalArgumentException - if topic invalid

query

public @NonNull TopicCommand query()

Sets this command to query the channel's current topic.

Returns:

this TopicCommand

execute

public void execute()

Description copied from class: Command

Executes the command.

Specified by:

execute in class Command<ChannelCommand<TopicCommand>>

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ChannelCommand<TopicCommand>

Returns:

the partial toString generator