org.kitteh.irc.client.library.command

Class KickCommand

java.lang.Object

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

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

org.kitteh.irc.client.library.command.KickCommand

All Implemented Interfaces:

ClientLinked

public class KickCommand
extends ChannelCommand<KickCommand>

Get your KICKs on Route 66.

Nested Class Summary

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

Command.Tags

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the command.
@NonNull KickCommand	reason(@Nullable String reason) Sets the reason for this kick.
@NonNull KickCommand	target(@NonNull String target) Sets the target of this kick.
@NonNull KickCommand	target(@NonNull User target) Sets the target of this kick.
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

KickCommand

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

Constructs a KICK command for a given channel.

Parameters:

client - the client on which this command is executing

channel - channel targeted

Throws:

IllegalArgumentException - if null parameters

See Also:

Channel.kick(User), Channel.kick(User, String)

Method Detail

target

public @NonNull KickCommand target(@NonNull String target)

Sets the target of this kick.

Parameters:

target - target

Returns:

this command

Throws:

IllegalArgumentException - if target is null or contains invalid characters

target

public @NonNull KickCommand target(@NonNull User target)

Sets the target of this kick.

Parameters:

target - target

Returns:

this command

Throws:

IllegalArgumentException - if target is null or from a different Client

reason

public @NonNull KickCommand reason(@Nullable String reason)

Sets the reason for this kick.

Parameters:

reason - reason or null to provide no reason

Returns:

this command

Throws:

IllegalArgumentException - if reason contains invalid characters

execute

public void execute()

Executes the command.

Specified by:

execute in class Command<ChannelCommand<KickCommand>>

Throws:

IllegalStateException - if target is not defined

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ChannelCommand<KickCommand>

Returns:

the partial toString generator