Author: mkirby
Date: 2011-11-04 00:08:20 -0700 (Fri, 04 Nov 2011)
New Revision: 27404
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/SearchWebServiceClient.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedEvent.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedListener.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedEvent.java
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedListener.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -4,6 +4,9 @@
import org.cytoscape.model.CyNetwork;
+/**
+ * @CyAPI.Spi.Interface
+ */
public interface NetworkImportWebServiceClient {
Set<CyNetwork> getNetworks();
}
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/SearchWebServiceClient.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/SearchWebServiceClient.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/SearchWebServiceClient.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -1,5 +1,8 @@
package org.cytoscape.io.webservice;
+/**
+ * @CyAPI.Spi.Interface
+ */
public interface SearchWebServiceClient<T> {
T getSearchResult();
}
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -4,6 +4,9 @@
import org.cytoscape.model.CyTable;
+/**
+ * @CyAPI.Spi.Interface
+ */
public interface TableImportWebServiceClient {
Set<CyTable> getTables();
}
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -45,7 +45,7 @@
*
* All web service clients <strong>must</strong> implement this method.
*
- *
+ * @CyAPI.Spi.Interface
*/
public interface WebServiceClient extends TaskFactory {
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -46,6 +46,7 @@
/**
* Abstract class for all web service clients.
* All clients MUST extend this class.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractWebServiceClient implements WebServiceClient {
@@ -62,6 +63,10 @@
protected Object currentQuery = null;
+ /**
+ * Constructs this AbstractWebServiceClient.
+ * @param uri Service Location.
+ */
public AbstractWebServiceClient(final String uri, final String
displayName, final String description) {
// Create URI
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedEvent.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedEvent.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedEvent.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -2,16 +2,29 @@
import org.cytoscape.event.AbstractCyEvent;
+/**
+ * #ASKMIKE needs class comment and should be declared as final
+ * @param <T> the generic type of the object associated with this
DataImportFinishedEvent.
+ * @CyAPI.Final.Class
+ */
public class DataImportFinishedEvent<T> extends AbstractCyEvent<Object> {
private final T imported;
+ /**
+ * Constructs the event.
+ * @param source the source of the object that was imported.
+ * @param imported the object that was imported.
+ */
public DataImportFinishedEvent(final Object source, final T imported) {
super(source, DataImportFinishedListener.class);
this.imported = imported;
}
+ /** Returns the object that was imported.
+ * @return the object that was imported.
+ */
public T getImportedObject() {
return this.imported;
}
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedListener.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedListener.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/DataImportFinishedListener.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -2,7 +2,12 @@
/**
* Listener for {@link DataImportFinishedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface DataImportFinishedListener {
+ /**
+ * The method that should handle the specified event.
+ * @param evt The event to be handled.
+ */
void handleEvent(DataImportFinishedEvent<?> evt);
}
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedEvent.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedEvent.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedEvent.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -2,10 +2,16 @@
import org.cytoscape.event.AbstractCyEvent;
+/**
+ * @CyAPI.Final.Class
+ */
public final class SearchFinishedEvent<T> extends AbstractCyEvent<Object> {
private final T searchResult;
+ /**
+ * Constructs the event.
+ */
public SearchFinishedEvent(final Object source,
final T result) {
super(source, SearchFinishedListener.class);
Modified:
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedListener.java
===================================================================
---
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedListener.java
2011-11-04 07:06:08 UTC (rev 27403)
+++
core3/api/trunk/webservice-api/src/main/java/org/cytoscape/io/webservice/events/SearchFinishedListener.java
2011-11-04 07:08:20 UTC (rev 27404)
@@ -2,7 +2,12 @@
/**
* Listener for {@link SearchFinishedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface SearchFinishedListener {
+ /**
+ * The method that should handle the specified event.
+ * @param evt The event to be handled. #ASKMIKE shouldn't it have <?>
+ */
void handleEvent(final SearchFinishedEvent evt);
}
--
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.
