org.kitteh.irc.client.library.command

Class Command<C extends Command<C>>

java.lang.Object

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

All Implemented Interfaces:

ClientLinked

Direct Known Subclasses:

AwayCommand, CapabilityRequestCommand, ChannelCommand, MessageCommand, MonitorCommand, NoticeCommand, OperCommand, SetNameCommand, TagMessageCommand, UserModeCommand, WallopsCommand, WhoisCommand

public abstract class Command<C extends Command<C>>
extends Object
implements ClientLinked

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Command.Tags

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract void	execute() Executes the command.
@NonNull Client	getClient() Gets the client on which this command will be run.
protected void	sendCommandLine(@NonNull String line)
protected void	sendCommandLine(@NonNull String line, boolean immediately)
Command.Tags	tags()
String	toString()
protected @NonNull 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

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

sendCommandLine

protected void sendCommandLine(@NonNull String line)

sendCommandLine

protected void sendCommandLine(@NonNull String line,
                               boolean immediately)

tags

public Command.Tags tags()

toString

public String toString()

Overrides:

toString in class Object

toStringer

protected @NonNull ToStringer toStringer()

Generates a partial ToStringer for the command.

Returns:

the partial toString generator