com.zerjio.JIRC
Interface TOPICListener


public interface TOPICListener

The basic interface for a TOPICMessage listener.


Method Summary
 boolean listensToTOPIC(java.lang.String channelName)
          Should return true if it listens to the particular channel and false otherwise.
 void TOPICReceived(TOPICMessage msg)
          This method should take care about an TOPICMessage that has been recieved.
 

Method Detail

TOPICReceived

public void TOPICReceived(TOPICMessage msg)
This method should take care about an TOPICMessage that has been recieved.

It should mark the message as used using IRCMessage.markAsUsed() in case that the information on the message has been used in any form. It is also responsible of using IRCMessage.mustBeDiscarded() if no other listener should get noticed about this message.

Parameters:
msg - The TOPICMessage that has been received.
See Also:
markAsUsed, mustBeDiscarded

listensToTOPIC

public boolean listensToTOPIC(java.lang.String channelName)
Should return true if it listens to the particular channel and false otherwise. If it always returns true it will listen to any TOPIC message. If it always returns false it will not listen to any TOPIC message.

Parameters:
channelName - The name of the channel that must be tested.
Returns:
true if the channelName is being listened. false if the channelName is not being listened.