org.kitteh.irc.client.library.command

Class TopicCommand

java.lang.Object

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

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

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

All Implemented Interfaces:

ClientLinked

public class TopicCommand
extends ChannelCommand

TOPICal command support.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the command.
TopicCommand	query() Sets this command to query the channel's current topic.
TopicCommand	topic(String topic) Sets the topic.
protected 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, 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

@Nonnull
public 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

@Nonnull
public 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

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ChannelCommand

Returns:

the partial toString generator