org.kitteh.irc.client.library.command

Class AwayCommand

java.lang.Object

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

org.kitteh.irc.client.library.command.AwayCommand

All Implemented Interfaces:

ClientLinked

public class AwayCommand
extends Command<AwayCommand>

Sends an AWAY 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
AwayCommand(@NonNull Client client) Constructs the command.

Method Summary

Modifier and Type	Method and Description
@NonNull AwayCommand	away(@Nullable String message) Sets the away message for the command.
void	execute() Executes the command.
@NonNull AwayCommand	notAway() Removes the away message, meaning the command will set the Client as not away.
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

AwayCommand

public AwayCommand(@NonNull Client client)

Constructs the command.

Parameters:

client - the client

Throws:

IllegalArgumentException - if client is null

Method Detail

away

public @NonNull AwayCommand away(@Nullable String message)

Sets the away message for the command.

Parameters:

message - away message or null to set as not away

Returns:

this command

Throws:

IllegalArgumentException - for invalid message

notAway

public @NonNull AwayCommand notAway()

Removes the away message, meaning the command will set the Client as not away.

Returns:

this command

execute

public void execute()

Description copied from class: Command

Executes the command.

Specified by:

execute in class Command<AwayCommand>

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command<AwayCommand>

Returns:

the partial toString generator