Package org.cytoscape.io.write
Interface CyPropertyWriterManager
- All Superinterfaces:
CyWriterManager<CyPropertyWriterFactory>
A
CyWriterManager
specific to writing property objects. See
CyProperty
for information on types of object expected.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 (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
-
Method Summary
Modifier and TypeMethodDescriptionReturns theCyFileFilter
s known to thisCyWriter
manager.getWriter(Object property, CyFileFilter filter, File file)
Returns theCyWriter
Task that will attempt to write the specified property object to the specified file of the specified file type.getWriter(Object property, CyFileFilter filter, OutputStream os)
Returns theCyWriter
Task that will attempt to write the specified property object to the specified output stream of the specified file type.Methods inherited from interface org.cytoscape.io.write.CyWriterManager
getMatchingFactory
-
Method Details
-
getAvailableWriterFilters
List<CyFileFilter> getAvailableWriterFilters()Returns theCyFileFilter
s known to thisCyWriter
manager.- Specified by:
getAvailableWriterFilters
in interfaceCyWriterManager<CyPropertyWriterFactory>
- Returns:
- the set of known file filters.
-
getWriter
Returns theCyWriter
Task that will attempt to write the specified property object to the specified file of the specified file type.- Parameters:
property
- The property object to be written.filter
- TheCyFileFilter
that defines the type of file to be written.file
- The file to be written.- Returns:
- The
CyWriter
Task that will attempt to write the specified property object to the specified file of the specified file type. - Throws:
Exception
-
getWriter
Returns theCyWriter
Task that will attempt to write the specified property object to the specified output stream of the specified file type.- Parameters:
property
- The property object to be written.filter
- TheCyFileFilter
that defines the type of file to be written.os
- The output stream to be written.- Returns:
- The
CyWriter
Task that will attempt to write the specified property object to the specified output stream of the specified file type. - Throws:
Exception
-