org.kitteh.irc.client.library.command

Class AwayCommand

java.lang.Object

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

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

All Implemented Interfaces:

ClientLinked

public class AwayCommand
extends Command

Sends an AWAY request to the server.

Constructor Summary

Constructors

Constructor and Description
AwayCommand(Client client) Constructs the command.

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the command.
AwayCommand	message(String message) Sets the away message for the command.
AwayCommand	messageRemove() Removes the away message, meaning the command will set the Client as not away.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.command.Command

getClient, 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

message

@Nonnull
public AwayCommand message(@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

messageRemove

@Nonnull
public AwayCommand messageRemove()

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

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: Command

Generates a partial ToStringer for the command.

Overrides:

toStringer in class Command

Returns:

the partial toString generator