org.kitteh.irc.client.library.command

Class ChannelModeCommand

java.lang.Object

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

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

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

All Implemented Interfaces:

ClientLinked

public class ChannelModeCommand
extends ChannelCommand<ChannelModeCommand>

Commands a la MODE.

Nested Class Summary

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

Command.Tags

Constructor Summary

Constructors

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

Method Summary

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

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

public @NonNull ChannelModeCommand add(ModeStatus.Action action,
                                       @NonNull ChannelMode mode)

Adds a mode change without a parameter.

Parameters:

action - adding or removing

mode - the mode to be changed

Returns:

this ModeCommand

Throws:

IllegalArgumentException - if mode invalid

add

public @NonNull ChannelModeCommand add(ModeStatus.Action action,
                                       @NonNull ChannelMode mode,
                                       @NonNull String parameter)

Adds a mode change.

Parameters:

action - adding or 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

public @NonNull ChannelModeCommand add(ModeStatus.Action action,
                                       @NonNull ChannelUserMode mode,
                                       @NonNull User parameter)

Adds a mode change.

Parameters:

action - adding or 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<ChannelCommand<ChannelModeCommand>>

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ChannelCommand<ChannelModeCommand>

Returns:

the partial toString generator