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

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

All Implemented Interfaces:

Mode

public class PrivateMode
extends GenericChannelMode

Private and Secret Channels - The channel flag 'p' is used to mark a channel "private" and the channel flag 's' to mark a channel "secret". Both properties are similar and conceal the existence of the channel from other users.

This means that there is no way of getting this channel's name from the server without being a member. In other words, these channels MUST be omitted from replies to queries like the WHOIS command.

When a channel is "secret", in addition to the restriction above, the server will act as if the channel does not exist for queries like the TOPIC, LIST, NAMES commands. Note that there is one exception to this rule: servers will correctly reply to the MODE command. Finally, secret channels are not accounted for in the reply to the LUSERS command (See "Internet Relay Chat: Client Protocol" [IRC- CLIENT]) when the <mask> parameter is specified.

The channel flags 'p' and 's' MUST NOT both be set at the same time. If a MODE message originating from a server sets the flag 'p' and the flag 's' is already set for the channel, the change is silently ignored. This should only happen during a split healing phase (mentioned in the "IRC Server Protocol" document [IRC-SERVER]).

(From RFC2811)

Nested Class Summary

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

Mode.Sign

Constructor Summary

PrivateMode()

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.GenericChannelMode

onePerChannel, 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

PrivateMode

public PrivateMode()

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