com.zerjio.JIRC
Interface MODEListener


public interface MODEListener

The basic interface for a MODEMessage and RPL_CHANNELMODEISMessage listener.


Method Summary
 boolean listensToMODE(java.lang.String receiver)
          Should return true if it listens to the particular channel or user and false otherwise.
 void MODEReceived(MODEMessage msg)
          This method should take care about an MODEMessage that has been recieved.
 void RPL_CHANNELMODEISReceived(RPL_CHANNELMODEISMessage msg)
          This method should take care about an RPL_CHANNELMODEISMessage that has been recieved.
 

Method Detail

MODEReceived

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

RPL_CHANNELMODEISReceived

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

listensToMODE

public boolean listensToMODE(java.lang.String receiver)
Should return true if it listens to the particular channel or user and false otherwise. If it always returns true it will listen to any MODE message. If it always returns false it will not listen to any MODEmessage.

Parameters:
receiver - The receiver that must be tested.
Returns:
true if the receiver is being listened. false if the receiver is not being listened.