org.kitteh.irc.client.library.command

Class ChannelModeCommand

java.lang.Object

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

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

org.kitteh.irc.client.library.command.ChannelModeCommand

All Implemented Interfaces:

ClientLinked

public class ChannelModeCommand
extends ChannelCommand

Commands a la MODE.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ChannelModeCommand	add(boolean add, ChannelMode mode) Adds a mode change without a parameter.
ChannelModeCommand	add(boolean add, ChannelMode mode, String parameter) Adds a mode change.
ChannelModeCommand	add(boolean add, ChannelUserMode mode, User parameter) Adds a mode change.
void	execute() Executes the command.
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

ChannelModeCommand

public ChannelModeCommand(@Nonnull
                          Client client,
                          @Nonnull
                          String channel)

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

add

@Nonnull
public ChannelModeCommand add(boolean add,
                                        @Nonnull
                                        ChannelMode mode)

Adds a mode change without a parameter.

Parameters:

add - true if adding, false if removing

mode - the mode to be changed

Returns:

this ModeCommand

Throws:

IllegalArgumentException - if mode invalid

add

@Nonnull
public ChannelModeCommand add(boolean add,
                                        @Nonnull
                                        ChannelMode mode,
                                        @Nonnull
                                        String parameter)

Adds a mode change.

Parameters:

add - true if adding, false if removing

mode - the mode to be changed

parameter - mode parameter

Returns:

this ModeCommand

Throws:

IllegalArgumentException - if mode invalid comes from a different client or parameter is null

add

@Nonnull
public ChannelModeCommand add(boolean add,
                                        @Nonnull
                                        ChannelUserMode mode,
                                        @Nonnull
                                        User parameter)

Adds a mode change.

Parameters:

add - true if adding, false if removing

mode - the mode to be changed

parameter - user whose nick will be sent

Returns:

this ModeCommand

Throws:

IllegalArgumentException - if mode invalid or either mode or user comes from a different client or parameter is null

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