f00f.net.irc.martyr.commands
Class JoinCommand

java.lang.Object
  |
  +--f00f.net.irc.martyr.commands.GenericInCommand
        |
        +--f00f.net.irc.martyr.commands.GenericCommand
              |
              +--f00f.net.irc.martyr.commands.JoinCommand

All Implemented Interfaces:

Command, InCommand, OutCommand

public class JoinCommand

extends GenericCommand

Defines JOIN command.

Fields inherited from class f00f.net.irc.martyr.commands.GenericInCommand

attributes

Constructor Summary

JoinCommand()
For use as a factory

JoinCommand(java.lang.String channel)
This constructor is used to make a request to join a channel.

JoinCommand(java.lang.String channel, java.lang.String secret)
This constructor is used to make a request to join a channel that requires a secret key to join.

Method Summary

java.lang.String	getChannel()
java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
java.lang.String	getSecret()
FullNick	getUser()
InCommand	parse(java.lang.String prefix, java.lang.String identifier, java.lang.String params) Parses a string and produces a formed command object, if it can.
java.lang.String	renderParams() Renders the parameters of this command.
boolean	updateClientState(ClientState state) By default, commands do not update the client state.
boolean	weJoined(ClientState state)

Methods inherited from class f00f.net.irc.martyr.commands.GenericCommand

render

Methods inherited from class f00f.net.irc.martyr.commands.GenericInCommand

getAttribute, getAttributeKeys, getIntParameter, getParameter, getSourceString, getState, selfRegister, setAttribute, setSourceString

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinCommand

public JoinCommand()

For use as a factory

JoinCommand

public JoinCommand(java.lang.String channel,
                   java.lang.String secret)

This constructor is used to make a request to join a channel that requires a secret key to join.

Parameters:

user - The user

secret - The secret key required to enter the channel, or null of none.

JoinCommand

public JoinCommand(java.lang.String channel)

This constructor is used to make a request to join a channel.

Method Detail

parse

public InCommand parse(java.lang.String prefix,
                       java.lang.String identifier,
                       java.lang.String params)

Description copied from class: GenericInCommand

Parses a string and produces a formed command object, if it can. Should return null if it cannot form the command object.

Overrides:

parse in class GenericInCommand

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.

renderParams

public java.lang.String renderParams()

Description copied from class: GenericCommand

Renders the parameters of this command.

Overrides:

renderParams in class GenericCommand

getChannel

public java.lang.String getChannel()

getSecret

public java.lang.String getSecret()

getUser

public FullNick getUser()

weJoined

public boolean weJoined(ClientState state)

updateClientState

public boolean updateClientState(ClientState state)

Description copied from class: GenericInCommand

By default, commands do not update the client state.

Overrides:

updateClientState in class GenericInCommand