org.kitteh.irc.client.library.command

Class KickCommand

java.lang.Object

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

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

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

All Implemented Interfaces:

ClientLinked

public class KickCommand
extends ChannelCommand

Get your KICKs on Route 66.

Constructor Summary

Constructors

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

Method Summary

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

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

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

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

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

Throws:

IllegalStateException - if target is not defined

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