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

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

All Implemented Interfaces:

Mode

public class VoiceMode
extends GenericChannelMode

Voice Privilege - The mode 'v' is used to give and take voice privilege to/from a channel member. Users with this privilege can talk on moderated channels. (See section 4.2.3 (Moderated Channel Flag).

(From RFC2811)

Nested Class Summary

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

Mode.Sign

Constructor Summary

VoiceMode()

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	recordInChannel() This mode should be recorded in the list of channel modes.
boolean	requiresParam() Should return true if this mode requires a parameter.

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

onePerChannel

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

VoiceMode

public VoiceMode()

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

recordInChannel

public boolean recordInChannel()

Description copied from interface: Mode

This mode should be recorded in the list of channel modes. This would NOT include such things as operator status, as it is recored with the Member object.

Specified by:

recordInChannel in interface Mode

Overrides:

recordInChannel in class GenericChannelMode

Returns:

True or false of the mode should be recorded in the list of channels

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