|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.net.ProtocolCommandSupport
public class ProtocolCommandSupport
ProtocolCommandSupport is a convenience class for managing a list of ProtocolCommandListeners and firing ProtocolCommandEvents. You can simply delegate ProtocolCommandEvent firing and listener registering/unregistering tasks to this class.
ProtocolCommandEvent
,
ProtocolCommandListener
,
Serialized FormConstructor Summary | |
---|---|
ProtocolCommandSupport(Object source)
Creates a ProtocolCommandSupport instance using the indicated source as the source of ProtocolCommandEvents. |
Method Summary | |
---|---|
void |
addProtocolCommandListener(ProtocolCommandListener listener)
Adds a ProtocolCommandListener. |
void |
fireCommandSent(String command,
String message)
Fires a ProtocolCommandEvent signalling the sending of a command to all registered listeners, invoking their protocolCommandSent()
methods. |
void |
fireReplyReceived(int replyCode,
String message)
Fires a ProtocolCommandEvent signalling the reception of a command reply to all registered listeners, invoking their protocolReplyReceived()
methods. |
int |
getListenerCount()
Returns the number of ProtocolCommandListeners currently registered. |
void |
removeProtocolCommandListener(ProtocolCommandListener listener)
Removes a ProtocolCommandListener. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProtocolCommandSupport(Object source)
source
- The source to use for all generated ProtocolCommandEvents.Method Detail |
---|
public void fireCommandSent(String command, String message)
protocolCommandSent()
methods.
command
- The string representation of the command type sent, not
including the arguments (e.g., "STAT" or "GET").message
- The entire command string verbatim as sent to the server,
including all arguments.public void fireReplyReceived(int replyCode, String message)
protocolReplyReceived()
methods.
replyCode
- The integer code indicating the natureof the reply.
This will be the protocol integer value for protocols
that use integer reply codes, or the reply class constant
corresponding to the reply for protocols like POP3 that use
strings like OK rather than integer codes (i.e., POP3Repy.OK).message
- The entire reply as received from the server.public void addProtocolCommandListener(ProtocolCommandListener listener)
listener
- The ProtocolCommandListener to add.public void removeProtocolCommandListener(ProtocolCommandListener listener)
listener
- The ProtocolCommandListener to remove.public int getListenerCount()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |