org.kitteh.irc.client.library.command

Class UserModeCommand

java.lang.Object

org.kitteh.irc.client.library.command.Command<UserModeCommand>

org.kitteh.irc.client.library.command.UserModeCommand

All Implemented Interfaces:

ClientLinked

public class UserModeCommand
extends Command<UserModeCommand>

Commands a la User MODE, without modes added will just query self.

Nested Class Summary

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

Command.Tags

Constructor Summary

Constructors

Constructor and Description
UserModeCommand(@NonNull Client client) Constructs a MODE command for a given user.

Method Summary

Modifier and Type	Method and Description
@NonNull UserModeCommand	add(ModeStatus.Action action, @NonNull UserMode mode) Adds a mode change without a parameter.
@NonNull UserModeCommand	add(ModeStatus.Action action, @NonNull UserMode mode, @NonNull String 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.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

UserModeCommand

public UserModeCommand(@NonNull Client client)

Constructs a MODE command for a given user.

Parameters:

client - the client on which this command is executing

Throws:

IllegalArgumentException - if null parameters

Method Detail

add

public @NonNull UserModeCommand add(ModeStatus.Action action,
                                    @NonNull UserMode 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 UserModeCommand add(ModeStatus.Action action,
                                    @NonNull UserMode 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

execute

public void execute()

Description copied from class: Command

Executes the command.

Specified by:

execute in class Command<UserModeCommand>

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command<UserModeCommand>

Returns:

the partial toString generator