f00f.net.irc.martyr.errors
Class ChannelInviteOnlyError

java.lang.Object
  |
  +--f00f.net.irc.martyr.commands.GenericCommand
        |
        +--f00f.net.irc.martyr.errors.GenericError
              |
              +--f00f.net.irc.martyr.errors.ChannelInviteOnlyError

All Implemented Interfaces:

Command

public class ChannelInviteOnlyError

extends GenericError

Constructor Summary

ChannelInviteOnlyError()

ChannelInviteOnlyError(java.lang.String chan, java.lang.String comment)

Method Summary

java.lang.String	getChannel()
java.lang.String	getComment()
java.lang.String	getIrcIdentifier() Returns the string IRC uses to identify this command.
State	getState() Some commands, when received by the server, can only occur in one state.
Command	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.

Methods inherited from class f00f.net.irc.martyr.errors.GenericError

renderCommand, renderParams

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

getIntParameter, getParameter, getSourceString, render, selfRegister, setSourceString, updateClientState

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelInviteOnlyError

public ChannelInviteOnlyError()

ChannelInviteOnlyError

public ChannelInviteOnlyError(java.lang.String chan,
                              java.lang.String comment)

Method Detail

getState

public State getState()

Description copied from class: GenericCommand

Some commands, when received by the server, can only occur in one state. Thus, when this command is received, the protocol should assume that it is that state. A command can use the 'unknown' state to indicate it can be received in any state (for example, ping). Most commands will occur in the REGISTERED state, so for a few exeptions, commands can leave this alone.

Overrides:

getState in class GenericCommand

getIrcIdentifier

public java.lang.String getIrcIdentifier()

Description copied from class: GenericCommand

Returns the string IRC uses to identify this command. Examples: NICK, PING, KILL, 332

Overrides:

getIrcIdentifier in class GenericCommand

getChannel

public java.lang.String getChannel()

getComment

public java.lang.String getComment()

parse

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

Description copied from class: GenericCommand

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 GenericCommand