org.kitteh.irc.client.library.command

Class Command

java.lang.Object

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

All Implemented Interfaces:

ClientLinked

Direct Known Subclasses:

AwayCommand, CapabilityRequestCommand, ChannelCommand, MonitorCommand, OperCommand, UserModeCommand, WallopsCommand, WhoisCommand

public abstract class Command
extends Object
implements ClientLinked

Represents a command which is executable on the server by the client.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Command(Client client) Constructs the command.

Method Summary

Modifier and Type	Method and Description
abstract void	execute() Executes the command.
Client	getClient() Gets the client on which this command will be run.
String	toString()
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Command

protected Command(@Nonnull
                  Client client)

Constructs the command.

Parameters:

client - the client

Throws:

IllegalArgumentException - if client is null

Method Detail

getClient

@Nonnull
public Client getClient()

Gets the client on which this command will be run.

Specified by:

getClient in interface ClientLinked

Returns:

the client

execute

public abstract void execute()

Executes the command.

toString

public String toString()

Overrides:

toString in class Object

toStringer

@Nonnull
protected ToStringer toStringer()

Generates a partial ToStringer for the command.

Returns:

the partial toString generator