f00f.net.irc.martyr.modes.channel
Class KeyMode

java.lang.Object
  f00f.net.irc.martyr.modes.GenericMode
      f00f.net.irc.martyr.modes.channel.GenericChannelMode
          f00f.net.irc.martyr.modes.channel.GenericChannelMask
              f00f.net.irc.martyr.modes.channel.KeyMode

All Implemented Interfaces:

Mode

public class KeyMode
extends GenericChannelMask

Channel Key - When a channel key is set (by using the mode 'k'), servers MUST reject their local users request to join the channel unless this key is given.

The channel key MUST only be made visible to the channel members in the reply sent by the server to a MODE query.

(From RFC2811)

Nested Class Summary

Nested classes/interfaces inherited from interface f00f.net.irc.martyr.Mode

Mode.Sign

Constructor Summary

KeyMode()

Method Summary

char	getChar() The character that represents this mode (ie o for operator)
Mode	newInstance() A Mode can be constructed and asked to make copies of itself.
boolean	requiresParam() Should return true if this mode requires a parameter.

Methods inherited from class f00f.net.irc.martyr.modes.channel.GenericChannelMask

onePerChannel

Methods inherited from class f00f.net.irc.martyr.modes.channel.GenericChannelMode

recordInChannel

Methods inherited from class f00f.net.irc.martyr.modes.GenericMode

equals, getParam, getSign, hashCode, setParam, setSign, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeyMode

public KeyMode()

Method Detail

requiresParam

public boolean requiresParam()

Description copied from interface: Mode

Should return true if this mode requires a parameter.

Returns:

True or false if a param is required for mode

getChar

public char getChar()

Description copied from interface: Mode

The character that represents this mode (ie o for operator)

Returns:

Character representation of mode

newInstance

public Mode newInstance()

Description copied from interface: Mode

A Mode can be constructed and asked to make copies of itself.

Returns:

New Mode instance