Author: mkirby
Date: 2011-10-14 01:00:06 -0700 (Fri, 14 Oct 2011)
New Revision: 27177
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
2011-10-14 07:55:02 UTC (rev 27176)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
2011-10-14 08:00:06 UTC (rev 27177)
@@ -25,7 +25,7 @@
private final Set<String> contentTypes;
private final String description;
private final StreamUtil streamUtil;
-
+ /** Type of data that this filter applys to. */
protected final DataCategory category;
private static final Logger logger =
LoggerFactory.getLogger(BasicCyFileFilter.class);
@@ -193,6 +193,7 @@
/**
* Returns a string containing the specified number of lines from the
* beginning of the file. This is useful for testing input streams.
+ * @param stream the input stream from which to read the header.
* @param numLines the number of lines from the beginning of the file.
* @return a string containing the specified number of lines from the
* beginning of the file.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
2011-10-14 07:55:02 UTC (rev 27176)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
2011-10-14 08:00:06 UTC (rev 27177)
@@ -4,7 +4,7 @@
import org.cytoscape.view.model.CyNetworkView;
import org.cytoscape.work.Task;
-/**
+/** #ASKMIKE
* An extension of the Task interface that returns an array of
* {@link org.cytoscape.view.model.CyNetworkView} objects as well as optional
* {@link org.cytoscape.view.vizmap.VisualStyle} objects that are read as part
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
2011-10-14 07:55:02 UTC (rev 27176)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
2011-10-14 08:00:06 UTC (rev 27177)
@@ -21,6 +21,7 @@
* file to a file type determined by a provided writer manager. This class
* is meant to be extended for specific file types such that the appropriate
* {@link org.cytoscape.io.write.CyWriter} can be identified.
+ * @param <T> Generic type that extends CyWriterManager.
*/
public abstract class AbstractCyWriter<T extends CyWriterManager> extends
AbstractTask
implements CyWriter
@@ -51,8 +52,12 @@
return outputFile;
}
+ /** An implementation of this method should return a file format
description
+ * from {@link CyFileFilter}, such that the string can be found in the
descriptionFilterMap.
+ * @return a file format description from {@link CyFileFilter}.
+ */
abstract protected String getExportFileFormat();
-
+ /** A Map that maps description strings to {@link CyFileFilter}s*/
protected final Map<String,CyFileFilter> descriptionFilterMap;
/**
--
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.
