f00f.net.irc.martyr.commands
Class AwayCommand

java.lang.Object
  f00f.net.irc.martyr.commands.AwayCommand

All Implemented Interfaces:

Command, OutCommand

public class AwayCommand
extends java.lang.Object
implements OutCommand

Defines the AWAY message which is used to indicate that you are or are not away from the keyboard.

Author:

Daniel Henninger

Constructor Summary

AwayCommand()
A blank AWAY command indicates that you are no longer away.

AwayCommand(java.lang.String awayMessage)
An AWAY command with a message indicates that you are in fact away.

Method Summary

java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	render() Forms a string appropriate to send to the server, if required.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwayCommand

public AwayCommand()

A blank AWAY command indicates that you are no longer away.

AwayCommand

public AwayCommand(java.lang.String awayMessage)

An AWAY command with a message indicates that you are in fact away.

Parameters:

awayMessage - Message indicating why you are away.

Method Detail

render

public java.lang.String render()

Description copied from interface: OutCommand

Forms a string appropriate to send to the server, if required. Some commands will have no such string, as they are received and not sent. The string returned is sent to the server verbatim.

Specified by:

render in interface OutCommand

Returns:

Rendered string

See Also:

OutCommand.render()

getIrcIdentifier

public java.lang.String getIrcIdentifier()

Description copied from interface: Command

Returns the string IRC uses to identify this command. Examples: NICK, PING, KILL, 332. Not strictly required for OutCommands as the irc identifier is expected to be part of the reder() result.

Specified by:

getIrcIdentifier in interface Command

Returns:

The IRC identifier string

See Also:

Command.getIrcIdentifier()