sashenka.irc
Class Channel

java.lang.Object
  |
  +--sashenka.irc.Channel
All Implemented Interfaces:
Destination

public class Channel
extends java.lang.Object
implements Destination


Field Summary
 java.lang.String name
           
 
Method Summary
 boolean equals(java.lang.Object o)
           
static Channel getChannelByName(java.lang.String name)
           
static java.util.List getChannels()
          Returns a new List containing all the channels that are known of.
 java.util.Set getUsers()
          Returns a set of all the users that are in the current channel.
 int hashCode()
           
 boolean hasUser(IRCUser u)
          Returns whether or not the given user is in the channel.
 boolean in()
           
 boolean isLurking()
          Returns whether or not the bot should be lurking in the given channel.
 boolean isOperator()
           
 boolean join()
           
 boolean lurking()
           
 boolean sendOK()
          Returns whether or not it is okay to send messages and traffic to this destination.
 void setIn(boolean in)
           
 void setJoin(boolean join)
           
 void setLurking(boolean lurking)
           
 void setOperator(boolean op)
           
 void setUsers(java.util.List users)
           
 java.lang.String toString()
           
 boolean wantOp()
          Returns whether or not the bot wants to be an operator in the channel.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

public java.lang.String name
Method Detail

getChannelByName

public static Channel getChannelByName(java.lang.String name)

getChannels

public static java.util.List getChannels()
Returns a new List containing all the channels that are known of. (Generally those that the bot is in or has been invited to.)


setUsers

public void setUsers(java.util.List users)

getUsers

public java.util.Set getUsers()
Returns a set of all the users that are in the current channel.


hasUser

public boolean hasUser(IRCUser u)
Returns whether or not the given user is in the channel.


wantOp

public boolean wantOp()
Returns whether or not the bot wants to be an operator in the channel.


isOperator

public boolean isOperator()

setOperator

public void setOperator(boolean op)

isLurking

public boolean isLurking()
Returns whether or not the bot should be lurking in the given channel. Lurking means that the channel should not send ANY public messages to that channel.


lurking

public boolean lurking()

setLurking

public void setLurking(boolean lurking)

join

public boolean join()

setJoin

public void setJoin(boolean join)

in

public boolean in()

setIn

public void setIn(boolean in)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

sendOK

public boolean sendOK()
Description copied from interface: Destination
Returns whether or not it is okay to send messages and traffic to this destination.

Specified by:
sendOK in interface Destination

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object