org.kitteh.irc.client.library.command

Class NoticeCommand

java.lang.Object

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

org.kitteh.irc.client.library.command.NoticeCommand

All Implemented Interfaces:

ClientLinked

public class NoticeCommand
extends Command<NoticeCommand>

Sends a notice.

Nested Class Summary

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

Command.Tags

Constructor Summary

Constructors

Constructor and Description
NoticeCommand(@NonNull Client client) Constructs a notice command.

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the command.
@NonNull NoticeCommand	message(@Nullable String message) Sets the message to send.
@NonNull NoticeCommand	target(@NonNull MessageReceiver target)
@NonNull NoticeCommand	target(@NonNull String target) Sets the target of this notice.
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

NoticeCommand

public NoticeCommand(@NonNull Client client)

Constructs a notice command.

Parameters:

client - the client on which this command is executing

Throws:

IllegalArgumentException - if null parameters

Method Detail

target

public @NonNull NoticeCommand target(@NonNull String target)

Sets the target of this notice.

Parameters:

target - target

Returns:

this command

Throws:

IllegalArgumentException - if target is null or contains invalid characters

target

public @NonNull NoticeCommand target(@NonNull MessageReceiver target)

message

public @NonNull NoticeCommand message(@Nullable String message)

Sets the message to send.

Parameters:

message - message

Returns:

this command

Throws:

IllegalArgumentException - if message contains invalid characters

execute

public void execute()

Executes the command.

Specified by:

execute in class Command<NoticeCommand>

Throws:

IllegalStateException - if target or message is not defined

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command<NoticeCommand>

Returns:

the partial toString generator