irc
Class ChanList

java.lang.Object
  |
  +--irc.IRCObject
        |
        +--irc.Source
              |
              +--irc.IRCSource
                    |
                    +--irc.ChanList

public class ChanList

extends IRCSource

A channel list handler.

Field Summary

Fields inherited from class irc.Source

_in, _server

Fields inherited from class irc.IRCObject

_ircConfiguration

Constructor Summary

ChanList(IRCConfiguration config, IRCServer server, java.lang.String name)
Create a new ChanList.

Method Summary

void	addChanListListener(ChanListListener lis) Add a ChanListListener.
void	addChannel(ChannelInfo nfo) Add a channel in the channel list.
void	begin() Begin a new channel listing.
void	end() End the channel listing.
ChannelInfo[]	getChannels() Get the channels.
java.lang.String	getName() Get the chanlist name.
java.lang.String	getType() Get this source type.
void	leave() Request the destruction of this chanlist.
boolean	mayDefault() Test whether this source may be used as a default source for system event output.
void	removeChanListListeners(ChanListListener lis) Remove a chanListListener.
boolean	talkable() Test wether this source can accept messages from user.

Methods inherited from class irc.IRCSource

getIRCServer

Methods inherited from class irc.Source

action, activate, addSourceListener, clear, getInterpretor, getServer, isActive, messageReceived, noticeReceived, release, removeSourceListener, report, sendString, setCTCPFilter, setInterpretor

Methods inherited from class irc.IRCObject

getColor, getIRCConfiguration, getText, getText, getText, getText, getTimeStamp

Methods inherited from class java.lang.Object

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

Constructor Detail

ChanList

public ChanList(IRCConfiguration config,
                IRCServer server,
                java.lang.String name)

Create a new ChanList.

Parameters:

config - the global configuration.

server - the IRCServer from where to retreive channel list.

name - the chanlist name.

Method Detail

getType

public java.lang.String getType()

Description copied from class: Source

Get this source type.

Specified by:

getType in class Source

Returns:

source type.

getName

public java.lang.String getName()

Get the chanlist name.

Specified by:

getName in class Source

Returns:

source name.

getChannels

public ChannelInfo[] getChannels()

Get the channels.

Returns:

array of all channels.

addChannel

public void addChannel(ChannelInfo nfo)

Add a channel in the channel list.

Parameters:

nfo - new channel to add.

begin

public void begin()

Begin a new channel listing. The channel list is cleared.

end

public void end()

End the channel listing.

addChanListListener

public void addChanListListener(ChanListListener lis)

Add a ChanListListener.

Parameters:

lis - listener to add.

removeChanListListeners

public void removeChanListListeners(ChanListListener lis)

Remove a chanListListener.

Parameters:

lis - listener to remove.

leave

public void leave()

Request the destruction of this chanlist.

Specified by:

leave in class Source

talkable

public boolean talkable()

Description copied from class: Source

Test wether this source can accept messages from user.

Specified by:

talkable in class Source

Returns:

true if this source accepts user input, false otherwise.

mayDefault

public boolean mayDefault()

Description copied from class: Source

Test whether this source may be used as a default source for system event output.

Overrides:

mayDefault in class Source

Returns:

true if this source may be used as a default source, false otherwise.