org.kitteh.irc.client.library.command

Class UserModeCommand

java.lang.Object

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

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

All Implemented Interfaces:

ClientLinked

public class UserModeCommand
extends Command

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UserModeCommand	add(boolean add, UserMode mode) Adds a mode change without a parameter.
UserModeCommand	add(boolean add, UserMode mode, String 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.Command

getClient, 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

@Nonnull
public UserModeCommand add(boolean add,
                                     @Nonnull
                                     UserMode 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 UserModeCommand add(boolean add,
                                     @Nonnull
                                     UserMode 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

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 Command

Returns:

the partial toString generator