Update of /cvsroot/asterisk-java/asterisk-java/src/net/sf/asterisk/manager
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21472/src/net/sf/asterisk/manager
Modified Files:
EventBuilder.java
Log Message:
added javadoc for registerEventClass methods
Index: EventBuilder.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/net/sf/asterisk/manager/EventBuilder.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -p -r1.8 -r1.9
--- EventBuilder.java 30 Sep 2004 09:51:02 -0000 1.8
+++ EventBuilder.java 2 Feb 2005 07:46:21 -0000 1.9
@@ -114,6 +114,14 @@ public class EventBuilder
registerEventClass(ZapShowChannelsCompleteEvent.class);
}
+ /**
+ * Registers a new event class. The event this class is registered for is simply derived
+ * from the name of the class by stripping any package name (if present) and stripping
+ * the sufffix "Event".
+ * For example <code>net.sf.asterisk.manager.event.JoinEvent</code> is registered for the
+ * event "Join".
+ * @param clazz the event class to register, must extend net.sf.asterisk.manager.event.Event.
+ */
public void registerEventClass(Class clazz)
{
String className;
@@ -137,6 +145,11 @@ public class EventBuilder
registerEventClass(eventType, clazz);
}
+ /**
+ * Registers a new event class for the event given by eventType.
+ * @param eventType the name of the event to register the class for. For example "Join".
+ * @param clazz the event class to register, must extend net.sf.asterisk.manager.event.Event.
+ */
public void registerEventClass(String eventType, Class clazz)
{
Constructor defaultConstructor;
|
