Package org.cytoscape.io.read
Interface InputStreamTaskFactory
-
- All Superinterfaces:
CyFileFilterProvider
- All Known Implementing Classes:
AbstractInputStreamTaskFactory
public interface InputStreamTaskFactory extends CyFileFilterProvider
A super interface that allows the input stream to be set for reader task factories.Module:
io-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>io-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TaskIterator
createTaskIterator(InputStream is, String inputName)
Sets the input stream that will be read by the Reader created from this factory.boolean
isReady(InputStream is, String inputName)
Returns true if the factory is ready to be produce a TaskIterator and false otherwise.-
Methods inherited from interface org.cytoscape.io.CyFileFilterProvider
getFileFilter
-
-
-
-
Method Detail
-
createTaskIterator
TaskIterator createTaskIterator(InputStream is, String inputName)
Sets the input stream that will be read by the Reader created from this factory.- Parameters:
is
- TheInputStream
to be read.inputName
- The name of the input.
-
isReady
boolean isReady(InputStream is, String inputName)
Returns true if the factory is ready to be produce a TaskIterator and false otherwise.- Parameters:
is
- TheInputStream
to be read.inputName
- The name of the input.- Returns:
- true if the factory is ready to be produce a TaskIterator and false otherwise.
-
-