org.kitteh.irc.client.library.command

Class MonitorCommand

java.lang.Object

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

org.kitteh.irc.client.library.command.MonitorCommand

All Implemented Interfaces:

ClientLinked

public class MonitorCommand
extends Command

Sends a MONITOR request to the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitorCommand.Action Describes an action to take with the MONITOR command.

Constructor Summary

Constructors

Constructor and Description
MonitorCommand(Client client) Constructs the command.

Method Summary

Modifier and Type	Method and Description
MonitorCommand	action(MonitorCommand.Action action) Sets the action for the command.
void	execute() Executes the command.
MonitorCommand	target(Collection<String> targets) Sets the target(s) for the command, assuming MonitorCommand.Action.ADD_TARGET or MonitorCommand.Action.REMOVE_TARGET.
MonitorCommand	target(String... targets) Sets the target(s) for the command, assuming MonitorCommand.Action.ADD_TARGET or MonitorCommand.Action.REMOVE_TARGET.
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

MonitorCommand

public MonitorCommand(@Nonnull
                      Client client)

Constructs the command.

Parameters:

client - the client

Throws:

IllegalArgumentException - if client is null

Method Detail

action

@Nonnull
public MonitorCommand action(@Nonnull
                                       MonitorCommand.Action action)

Sets the action for the command.

Parameters:

action - action to take

Returns:

this command

Throws:

IllegalArgumentException - for null action

target

@Nonnull
public MonitorCommand target(@Nonnull
                                       String... targets)

Sets the target(s) for the command, assuming MonitorCommand.Action.ADD_TARGET or MonitorCommand.Action.REMOVE_TARGET.

Parameters:

targets - targets to add/remove

Returns:

this command

Throws:

IllegalArgumentException - for \n, \r, \0, or comma in target or null target

target

@Nonnull
public MonitorCommand target(@Nonnull
                                       Collection<String> targets)

Sets the target(s) for the command, assuming MonitorCommand.Action.ADD_TARGET or MonitorCommand.Action.REMOVE_TARGET.

Parameters:

targets - targets to add/remove

Returns:

this command

Throws:

IllegalArgumentException - for \n, \r, \0, or comma in target or null target

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