Author: ruschein
Date: 2010-10-21 08:49:19 -0700 (Thu, 21 Oct 2010)
New Revision: 22327
Modified:
core3/event-api/trunk/src/main/java/org/cytoscape/event/CyEventHelper.java
core3/event-api/trunk/src/main/java/org/cytoscape/event/CyListener.java
Log:
Very minor cleanup.
Modified:
core3/event-api/trunk/src/main/java/org/cytoscape/event/CyEventHelper.java
===================================================================
--- core3/event-api/trunk/src/main/java/org/cytoscape/event/CyEventHelper.java
2010-10-21 04:40:08 UTC (rev 22326)
+++ core3/event-api/trunk/src/main/java/org/cytoscape/event/CyEventHelper.java
2010-10-21 15:49:19 UTC (rev 22327)
@@ -1,14 +1,6 @@
-
/*
- Copyright (c) 2008, The Cytoscape Consortium (www.cytoscape.org)
+ Copyright (c) 2008, 2010, The Cytoscape Consortium (www.cytoscape.org)
- The Cytoscape Consortium is:
- - Institute for Systems Biology
- - University of California San Diego
- - Memorial Sloan-Kettering Cancer Center
- - Institut Pasteur
- - Agilent Technologies
-
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
@@ -33,16 +25,15 @@
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
-
package org.cytoscape.event;
+
/**
* The basic event handling interface for Cytoscape. All Cytoscape events
* should be fired using these methods. All listeners should be registered
* as CyListener or CyMicroListener services.
*/
public interface CyEventHelper {
-
/**
* Calls each listener found in the Service Registry identified by the
listenerClass
* interface by the supplied CyEvent.
@@ -66,18 +57,19 @@
* Returns a single instance of CyMicroListener that will in turn
execute any method
* executed on the returned object on all registered CyMicroListeners
for the specified
* event source object. So, executing the following code:
- * <br/>
+ * <code>
* eventHelper.getMicroListener(SomeListener.class,
this).someEvent(...);
- * <br/>
+ * </code>
* will execute the "someEvent(...)" method on every registered
SomeListener
* that is listening for events from "this" event source.
* <br/>
* In general, CyMicroListener should avoided in favor the
CyEvent/CyListener combination
* as that code provides more flexibility for backwards compatibility.
CyMicroListener
- * should <b>only</b> be used when high performance is absolutely
necessary <b>AND</b>
+ * should <b>only</b> be used when high performance is absolutely
necessary <b>and</b>
* when CyEvent/CyListener has been demonstrated to be inadequate!
*
- * @param <M> The type of micro listener requested.
+ * @param <M> the type of micro listener requested.
+ * @param m the class object for type M
* @param source The source object that fires the event.
* @return A single instance CyMicroListener of type M that will in
turn execute any
* called methods on all registered CyMicroListeners.
Modified:
core3/event-api/trunk/src/main/java/org/cytoscape/event/CyListener.java
===================================================================
--- core3/event-api/trunk/src/main/java/org/cytoscape/event/CyListener.java
2010-10-21 04:40:08 UTC (rev 22326)
+++ core3/event-api/trunk/src/main/java/org/cytoscape/event/CyListener.java
2010-10-21 15:49:19 UTC (rev 22327)
@@ -1,14 +1,6 @@
-
/*
- Copyright (c) 2008, The Cytoscape Consortium (www.cytoscape.org)
+ Copyright (c) 2008, 2010, The Cytoscape Consortium (www.cytoscape.org)
- The Cytoscape Consortium is:
- - Institute for Systems Biology
- - University of California San Diego
- - Memorial Sloan-Kettering Cancer Center
- - Institut Pasteur
- - Agilent Technologies
-
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
@@ -33,9 +25,9 @@
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
-
package org.cytoscape.event;
+
/**
* The basic interface that any class interested in a particular
* type of event should implement.
@@ -45,7 +37,7 @@
* <p>where ZZZ extends CyEvent! </b>
* <p>
* Unfortunately, we can't parameterize this
- * because Java doesn't reiify generic types, meaning a class
+ * because Java doesn't reify generic types, meaning a class
* could only implement ONE instance of this interface,
* something that doesn't work for us. And so we leave it
* to convention.
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
