org.kitteh.irc.client.library.command

Class MonitorCommand

java.lang.Object

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

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

All Implemented Interfaces:

ClientLinked

public class MonitorCommand
extends Command<MonitorCommand>

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.

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

Command.Tags

Constructor Summary

Constructors

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

Method Summary

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

MonitorCommand

public MonitorCommand(@NonNull Client client)

Constructs the command.

Parameters:

client - the client

Throws:

IllegalArgumentException - if client is null

Method Detail

action

public @NonNull 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

public @NonNull MonitorCommand target(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

public @NonNull 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<MonitorCommand>

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command<MonitorCommand>

Returns:

the partial toString generator