org.kitteh.irc.client.library.command

Class CapabilityRequestCommand

java.lang.Object

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

org.kitteh.irc.client.library.command.CapabilityRequestCommand

All Implemented Interfaces:

ClientLinked

public class CapabilityRequestCommand
extends Command<CapabilityRequestCommand>

Sends a capability request to the server.

Nested Class Summary

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

Command.Tags

Constructor Summary

Constructors

Constructor and Description
CapabilityRequestCommand(@NonNull Client client) Constructs the CAP REQ command.

Method Summary

Modifier and Type	Method and Description
@NonNull CapabilityRequestCommand	disable(@NonNull String capability) Adds a capability identifier to request disabling.
@NonNull CapabilityRequestCommand	enable(@NonNull String capability) Adds a capability identifier to request enabling.
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

CapabilityRequestCommand

public CapabilityRequestCommand(@NonNull Client client)

Constructs the CAP REQ command.

Parameters:

client - the client

Throws:

IllegalArgumentException - if client is null

Method Detail

enable

public @NonNull CapabilityRequestCommand enable(@NonNull String capability)

Adds a capability identifier to request enabling.

Parameters:

capability - capability requested

Returns:

this command

Throws:

IllegalArgumentException - if capability is null

See Also:

CapabilityManager.getCapabilities(), CapabilityManager.getSupportedCapabilities()

disable

public @NonNull CapabilityRequestCommand disable(@NonNull String capability)

Adds a capability identifier to request disabling.

Parameters:

capability - capability requested

Returns:

this command

Throws:

IllegalArgumentException - if capability is null

See Also:

CapabilityManager.getCapabilities()

execute

public void execute()

Description copied from class: Command

Executes the command.

Specified by:

execute in class Command<CapabilityRequestCommand>

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command<CapabilityRequestCommand>

Returns:

the partial toString generator