com.zerjio.JIRC
Interface NAMESListener


public interface NAMESListener

The basic interface for a RPL_NAMEREPLYMessage, RPL_ENDOFNAMESMessage listener.


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

Method Detail

RPL_NAMEREPLYReceived

public void RPL_NAMEREPLYReceived(RPL_NAMEREPLYMessage msg)
This method should take care about an RPL_NAMEREPLYMessage 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 RPL_NAMEREPLYMessage that has been received.
See Also:
markAsUsed, mustBeDiscarded

RPL_ENDOFNAMESReceived

public void RPL_ENDOFNAMESReceived(RPL_ENDOFNAMESMessage msg)
This method should take care about an RPL_ENDOFNAMESMessage 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 RPL_ENDOFNAMESMessage that has been received.
See Also:
markAsUsed, mustBeDiscarded

listensToNAMES

public boolean listensToNAMES(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 NAME message. If it always returns false it will not listen to any NAME 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.